Interface RouterInterfaceOrBuilder (1.55.0)

public interface RouterInterfaceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIpRange()

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

getPrivateIpAddress()

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

getSubnetwork()

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