target.apidocs.com.google.api.services.compute.model.RouterInterface.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







RouterInterface (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class RouterInterface



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.RouterInterface













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class RouterInterface
extends com.google.api.client.json.GenericJson
Model definition for RouterInterface.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


RouterInterface() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


RouterInterface
clone() 


String
getIpRange()
IP address and range of the interface.



String
getIpVersion()
IP version of this interface.



String
getLinkedInterconnectAttachment()
URI of the linked Interconnect attachment.



String
getLinkedVpnTunnel()
URI of the linked VPN tunnel, which must be in the same region as the router.



String
getManagementType()
[Output Only] The resource that configures and manages this interface.



String
getName()
Name of this interface entry.



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.



String
getRedundantInterface()
Name of the interface that will be redundant with the current interface you are creating.



String
getSubnetwork()
The URI of the subnetwork resource that this interface belongs to, which must be in the same
 region as the Cloud Router.



RouterInterface
set(String fieldName,
   Object value) 


RouterInterface
setIpRange(String ipRange)
IP address and range of the interface.



RouterInterface
setIpVersion(String ipVersion)
IP version of this interface.



RouterInterface
setLinkedInterconnectAttachment(String linkedInterconnectAttachment)
URI of the linked Interconnect attachment.



RouterInterface
setLinkedVpnTunnel(String linkedVpnTunnel)
URI of the linked VPN tunnel, which must be in the same region as the router.



RouterInterface
setManagementType(String managementType)
[Output Only] The resource that configures and manages this interface.



RouterInterface
setName(String name)
Name of this interface entry.



RouterInterface
setPrivateIpAddress(String privateIpAddress)
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.



RouterInterface
setRedundantInterface(String redundantInterface)
Name of the interface that will be redundant with the current interface you are creating.



RouterInterface
setSubnetwork(String subnetwork)
The URI of the subnetwork resource that this interface belongs to, which must be in the same
 region as the Cloud Router.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





RouterInterface
public RouterInterface()









Method Detail





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.

Returns:
value or null for none








setIpRange
public RouterInterface setIpRange(String ipRange)
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.

Parameters:
ipRange - ipRange or null for none








getIpVersion
public String getIpVersion()
IP version of this interface.

Returns:
value or null for none








setIpVersion
public RouterInterface setIpVersion(String ipVersion)
IP version of this interface.

Parameters:
ipVersion - ipVersion or null for none








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.

Returns:
value or null for none








setLinkedInterconnectAttachment
public RouterInterface setLinkedInterconnectAttachment(String linkedInterconnectAttachment)
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.

Parameters:
linkedInterconnectAttachment - linkedInterconnectAttachment or null for none








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.

Returns:
value or null for none








setLinkedVpnTunnel
public RouterInterface setLinkedVpnTunnel(String linkedVpnTunnel)
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.

Parameters:
linkedVpnTunnel - linkedVpnTunnel or null for none








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.

Returns:
value or null for none








setManagementType
public RouterInterface setManagementType(String managementType)
[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.

Parameters:
managementType - managementType or null for none








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]([-a-z0-9]*[a-z0-9])?` 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.

Returns:
value or null for none








setName
public RouterInterface setName(String name)
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]([-a-z0-9]*[a-z0-9])?` 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.

Parameters:
name - name or null for none








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.

Returns:
value or null for none








setPrivateIpAddress
public RouterInterface setPrivateIpAddress(String privateIpAddress)
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.

Parameters:
privateIpAddress - privateIpAddress or null for none








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]([-a-z0-9]*[a-z0-9])?`
 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.

Returns:
value or null for none








setRedundantInterface
public RouterInterface setRedundantInterface(String redundantInterface)
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]([-a-z0-9]*[a-z0-9])?`
 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.

Parameters:
redundantInterface - redundantInterface or null for none








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.

Returns:
value or null for none








setSubnetwork
public RouterInterface setSubnetwork(String subnetwork)
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.

Parameters:
subnetwork - subnetwork or null for none








set
public RouterInterface set(String fieldName,
                           Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public RouterInterface clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`RouterInterface`	`clone()`
`String`	`getIpRange()` IP address and range of the interface.
`String`	`getIpVersion()` IP version of this interface.
`String`	`getLinkedInterconnectAttachment()` URI of the linked Interconnect attachment.
`String`	`getLinkedVpnTunnel()` URI of the linked VPN tunnel, which must be in the same region as the router.
`String`	`getManagementType()` [Output Only] The resource that configures and manages this interface.
`String`	`getName()` Name of this interface entry.
`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.
`String`	`getRedundantInterface()` Name of the interface that will be redundant with the current interface you are creating.
`String`	`getSubnetwork()` The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router.
`RouterInterface`	`set(String fieldName, Object value)`
`RouterInterface`	`setIpRange(String ipRange)` IP address and range of the interface.
`RouterInterface`	`setIpVersion(String ipVersion)` IP version of this interface.
`RouterInterface`	`setLinkedInterconnectAttachment(String linkedInterconnectAttachment)` URI of the linked Interconnect attachment.
`RouterInterface`	`setLinkedVpnTunnel(String linkedVpnTunnel)` URI of the linked VPN tunnel, which must be in the same region as the router.
`RouterInterface`	`setManagementType(String managementType)` [Output Only] The resource that configures and manages this interface.
`RouterInterface`	`setName(String name)` Name of this interface entry.
`RouterInterface`	`setPrivateIpAddress(String privateIpAddress)` 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.
`RouterInterface`	`setRedundantInterface(String redundantInterface)` Name of the interface that will be redundant with the current interface you are creating.
`RouterInterface`	`setSubnetwork(String subnetwork)` The URI of the subnetwork resource that this interface belongs to, which must be in the same region as the Cloud Router.