Class RouterBgp (1.58.0)

public final class RouterBgp extends GeneratedMessageV3 implements RouterBgpOrBuilder

Protobuf type google.cloud.compute.v1.RouterBgp

Implements

RouterBgpOrBuilder

Static 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

ADVERTISE_MODE_FIELD_NUMBER

public static final int ADVERTISE_MODE_FIELD_NUMBER
Field Value
Type Description
int

ASN_FIELD_NUMBER

public static final int ASN_FIELD_NUMBER
Field Value
Type Description
int

IDENTIFIER_RANGE_FIELD_NUMBER

public static final int IDENTIFIER_RANGE_FIELD_NUMBER
Field Value
Type Description
int

KEEPALIVE_INTERVAL_FIELD_NUMBER

public static final int KEEPALIVE_INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RouterBgp getDefaultInstance()
Returns
Type Description
RouterBgp

getDescriptor()

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

newBuilder()

public static RouterBgp.Builder newBuilder()
Returns
Type Description
RouterBgp.Builder

newBuilder(RouterBgp prototype)

public static RouterBgp.Builder newBuilder(RouterBgp prototype)
Parameter
Name Description
prototype RouterBgp
Returns
Type Description
RouterBgp.Builder

parseDelimitedFrom(InputStream input)

public static RouterBgp parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RouterBgp
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RouterBgp parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgp
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RouterBgp parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RouterBgp
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RouterBgp parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgp
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RouterBgp parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RouterBgp
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RouterBgp parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgp
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RouterBgp parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RouterBgp
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RouterBgp parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgp
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RouterBgp parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RouterBgp
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RouterBgp parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgp
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RouterBgp parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RouterBgp
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RouterBgp parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouterBgp
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RouterBgp> parser()
Returns
Type Description
Parser<RouterBgp>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdvertiseMode()

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

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. The options are DEFAULT or CUSTOM. 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. 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.

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

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

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

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

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

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

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

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

repeated .google.cloud.compute.v1.RouterAdvertisedIpRange advertised_ip_ranges = 35449932;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.RouterAdvertisedIpRangeOrBuilder>

getAsn()

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

optional uint32 asn = 96892;

Returns
Type Description
int

The asn.

getDefaultInstanceForType()

public RouterBgp getDefaultInstanceForType()
Returns
Type Description
RouterBgp

getIdentifierRange()

public String getIdentifierRange()

Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this "router ID".

optional string identifier_range = 501573159;

Returns
Type Description
String

The identifierRange.

getIdentifierRangeBytes()

public ByteString getIdentifierRangeBytes()

Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this "router ID".

optional string identifier_range = 501573159;

Returns
Type Description
ByteString

The bytes for identifierRange.

getKeepaliveInterval()

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

optional uint32 keepalive_interval = 276771516;

Returns
Type Description
int

The keepaliveInterval.

getParserForType()

public Parser<RouterBgp> getParserForType()
Returns
Type Description
Parser<RouterBgp>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAdvertiseMode()

public boolean hasAdvertiseMode()

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.

optional string advertise_mode = 312134331;

Returns
Type Description
boolean

Whether the advertiseMode field is set.

hasAsn()

public boolean hasAsn()

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.

optional uint32 asn = 96892;

Returns
Type Description
boolean

Whether the asn field is set.

hasIdentifierRange()

public boolean hasIdentifierRange()

Explicitly specifies a range of valid BGP Identifiers for this Router. It is provided as a link-local IPv4 range (from 169.254.0.0/16), of size at least /30, even if the BGP sessions are over IPv6. It must not overlap with any IPv4 BGP session ranges. Other vendors commonly call this "router ID".

optional string identifier_range = 501573159;

Returns
Type Description
boolean

Whether the identifierRange field is set.

hasKeepaliveInterval()

public boolean hasKeepaliveInterval()

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.

optional uint32 keepalive_interval = 276771516;

Returns
Type Description
boolean

Whether the keepaliveInterval field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RouterBgp.Builder newBuilderForType()
Returns
Type Description
RouterBgp.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RouterBgp.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RouterBgp.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RouterBgp.Builder toBuilder()
Returns
Type Description
RouterBgp.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException