Class RouterInterface (1.61.0)

public final class RouterInterface extends GeneratedMessageV3 implements RouterInterfaceOrBuilder

Protobuf type google.cloud.compute.v1.RouterInterface

Static Fields

IP_RANGE_FIELD_NUMBER

public static final int IP_RANGE_FIELD_NUMBER
Field Value
Type Description
int

IP_VERSION_FIELD_NUMBER

public static final int IP_VERSION_FIELD_NUMBER
Field Value
Type Description
int

LINKED_INTERCONNECT_ATTACHMENT_FIELD_NUMBER

public static final int LINKED_INTERCONNECT_ATTACHMENT_FIELD_NUMBER
Field Value
Type Description
int

LINKED_VPN_TUNNEL_FIELD_NUMBER

public static final int LINKED_VPN_TUNNEL_FIELD_NUMBER
Field Value
Type Description
int

MANAGEMENT_TYPE_FIELD_NUMBER

public static final int MANAGEMENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_IP_ADDRESS_FIELD_NUMBER

public static final int PRIVATE_IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

REDUNDANT_INTERFACE_FIELD_NUMBER

public static final int REDUNDANT_INTERFACE_FIELD_NUMBER
Field Value
Type Description
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RouterInterface getDefaultInstance()
Returns
Type Description
RouterInterface

getDescriptor()

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

newBuilder()

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

newBuilder(RouterInterface prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RouterInterface getDefaultInstanceForType()
Returns
Type Description
RouterInterface

getIpRange()

public String getIpRange()

IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose.

optional string ip_range = 145092645;

Returns
Type Description
String

The ipRange.

getIpRangeBytes()

public ByteString getIpRangeBytes()

IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose.

optional string ip_range = 145092645;

Returns
Type Description
ByteString

The bytes for ipRange.

getIpVersion()

public String getIpVersion()

IP version of this interface. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type Description
String

The ipVersion.

getIpVersionBytes()

public ByteString getIpVersionBytes()

IP version of this interface. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type Description
ByteString

The bytes for ipVersion.

getLinkedInterconnectAttachment()

public String getLinkedInterconnectAttachment()

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

optional string linked_interconnect_attachment = 501085518;

Returns
Type Description
String

The linkedInterconnectAttachment.

getLinkedInterconnectAttachmentBytes()

public ByteString getLinkedInterconnectAttachmentBytes()

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

optional string linked_interconnect_attachment = 501085518;

Returns
Type Description
ByteString

The bytes for linkedInterconnectAttachment.

getLinkedVpnTunnel()

public String getLinkedVpnTunnel()

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

optional string linked_vpn_tunnel = 352296953;

Returns
Type Description
String

The linkedVpnTunnel.

getLinkedVpnTunnelBytes()

public ByteString getLinkedVpnTunnelBytes()

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

optional string linked_vpn_tunnel = 352296953;

Returns
Type Description
ByteString

The bytes for linkedVpnTunnel.

getManagementType()

public String getManagementType()

[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface 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 interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface 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.

getName()

public String getName()

Name of this interface entry. 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 interface entry. 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<RouterInterface> getParserForType()
Returns
Type Description
Parser<RouterInterface>
Overrides

getPrivateIpAddress()

public String getPrivateIpAddress()

The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

optional string private_ip_address = 100854040;

Returns
Type Description
String

The privateIpAddress.

getPrivateIpAddressBytes()

public ByteString getPrivateIpAddressBytes()

The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

optional string private_ip_address = 100854040;

Returns
Type Description
ByteString

The bytes for privateIpAddress.

getRedundantInterface()

public String getRedundantInterface()

Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface 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 redundant_interface = 523187303;

Returns
Type Description
String

The redundantInterface.

getRedundantInterfaceBytes()

public ByteString getRedundantInterfaceBytes()

Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface 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 redundant_interface = 523187303;

Returns
Type Description
ByteString

The bytes for redundantInterface.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSubnetwork()

public String getSubnetwork()

The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

optional string subnetwork = 307827694;

Returns
Type Description
String

The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

optional string subnetwork = 307827694;

Returns
Type Description
ByteString

The bytes for subnetwork.

hasIpRange()

public boolean hasIpRange()

IP address and range of the interface. - For Internet Protocol version 4 (IPv4), the IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example, 169.254.0.1/30. Note: Do not truncate the IP address, as it represents the IP address of the interface. - For Internet Protocol version 6 (IPv6), the value must be a unique local address (ULA) range from fdff:1::/64 with a mask length of 126 or less. This value should be a CIDR-formatted string, for example, fc00:0:1:1::1/112. Within the router's VPC, this IPv6 prefix will be reserved exclusively for this connection and cannot be used for any other purpose.

optional string ip_range = 145092645;

Returns
Type Description
boolean

Whether the ipRange field is set.

hasIpVersion()

public boolean hasIpVersion()

IP version of this interface. Check the IpVersion enum for the list of possible values.

optional string ip_version = 294959552;

Returns
Type Description
boolean

Whether the ipVersion field is set.

hasLinkedInterconnectAttachment()

public boolean hasLinkedInterconnectAttachment()

URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

optional string linked_interconnect_attachment = 501085518;

Returns
Type Description
boolean

Whether the linkedInterconnectAttachment field is set.

hasLinkedVpnTunnel()

public boolean hasLinkedVpnTunnel()

URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a subnetwork.

optional string linked_vpn_tunnel = 352296953;

Returns
Type Description
boolean

Whether the linkedVpnTunnel field is set.

hasManagementType()

public boolean hasManagementType()

[Output Only] The resource that configures and manages this interface. - MANAGED_BY_USER is the default value and can be managed directly by users. - MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface 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.

hasName()

public boolean hasName()

Name of this interface entry. 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.

hasPrivateIpAddress()

public boolean hasPrivateIpAddress()

The regional private internal IP address that is used to establish BGP sessions to a VM instance acting as a third-party Router Appliance, such as a Next Gen Firewall, a Virtual Router, or an SD-WAN VM.

optional string private_ip_address = 100854040;

Returns
Type Description
boolean

Whether the privateIpAddress field is set.

hasRedundantInterface()

public boolean hasRedundantInterface()

Name of the interface that will be redundant with the current interface you are creating. The redundantInterface must belong to the same Cloud Router as the interface here. To establish the BGP session to a Router Appliance VM, you must create two BGP peers. The two BGP peers must be attached to two separate interfaces that are redundant with each other. The redundant_interface must be 1-63 characters long, and comply with RFC1035. Specifically, the redundant_interface 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 redundant_interface = 523187303;

Returns
Type Description
boolean

Whether the redundantInterface field is set.

hasSubnetwork()

public boolean hasSubnetwork()

The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router. When you establish a BGP session to a VM instance using this interface, the VM instance must belong to the same subnetwork as the subnetwork specified here.

optional string subnetwork = 307827694;

Returns
Type Description
boolean

Whether the subnetwork 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 RouterInterface.Builder newBuilderForType()
Returns
Type Description
RouterInterface.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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