com.google.api.services.compute.model

Class NetworkInterface

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class NetworkInterface
extends GenericJson

A network interface resource attached to an instance.

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

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
NetworkInterface()

Method Summary

Modifier and Type	Method and Description
NetworkInterface	clone()
byte[]	decodeFingerprint() Fingerprint hash of contents stored in this network interface.
NetworkInterface	encodeFingerprint(byte[] fingerprint) Fingerprint hash of contents stored in this network interface.
List<AccessConfig>	getAccessConfigs() An array of configurations for this interface.
List<AliasIpRange>	getAliasIpRanges() An array of alias IP ranges for this network interface.
String	getFingerprint() Fingerprint hash of contents stored in this network interface.
Integer	getInternalIpv6PrefixLength() The prefix length of the primary internal IPv6 range.
List<AccessConfig>	getIpv6AccessConfigs() An array of IPv6 access configurations for this interface.
String	getIpv6AccessType() [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet.
String	getIpv6Address() An IPv6 internal network address for this network interface.
String	getKind() [Output Only] Type of the resource.
String	getName() [Output Only] The name of the network interface, which is generated by the server.
String	getNetwork() URL of the VPC network resource for this instance.
String	getNetworkIP() An IPv4 internal IP address to assign to the instance for this network interface.
String	getNicType() The type of vNIC to be used on this interface.
Integer	getQueueCount() The networking queue count that's specified by users for the network interface.
String	getStackType() The stack type for this network interface to identify whether the IPv6 feature is enabled or not.
String	getSubnetwork() The URL of the Subnetwork resource for this instance.
NetworkInterface	set(String fieldName, Object value)
NetworkInterface	setAccessConfigs(List<AccessConfig> accessConfigs) An array of configurations for this interface.
NetworkInterface	setAliasIpRanges(List<AliasIpRange> aliasIpRanges) An array of alias IP ranges for this network interface.
NetworkInterface	setFingerprint(String fingerprint) Fingerprint hash of contents stored in this network interface.
NetworkInterface	setInternalIpv6PrefixLength(Integer internalIpv6PrefixLength) The prefix length of the primary internal IPv6 range.
NetworkInterface	setIpv6AccessConfigs(List<AccessConfig> ipv6AccessConfigs) An array of IPv6 access configurations for this interface.
NetworkInterface	setIpv6AccessType(String ipv6AccessType) [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet.
NetworkInterface	setIpv6Address(String ipv6Address) An IPv6 internal network address for this network interface.
NetworkInterface	setKind(String kind) [Output Only] Type of the resource.
NetworkInterface	setName(String name) [Output Only] The name of the network interface, which is generated by the server.
NetworkInterface	setNetwork(String network) URL of the VPC network resource for this instance.
NetworkInterface	setNetworkIP(String networkIP) An IPv4 internal IP address to assign to the instance for this network interface.
NetworkInterface	setNicType(String nicType) The type of vNIC to be used on this interface.
NetworkInterface	setQueueCount(Integer queueCount) The networking queue count that's specified by users for the network interface.
NetworkInterface	setStackType(String stackType) The stack type for this network interface to identify whether the IPv6 feature is enabled or not.
NetworkInterface	setSubnetwork(String subnetwork) The URL of the Subnetwork resource for this instance.

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

NetworkInterface

public NetworkInterface()

Method Detail

getAccessConfigs

public List<AccessConfig> getAccessConfigs()

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

Returns:

value or null for none

setAccessConfigs

public NetworkInterface setAccessConfigs(List<AccessConfig> accessConfigs)

An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.

Parameters:

accessConfigs - accessConfigs or null for none

getAliasIpRanges

public List<AliasIpRange> getAliasIpRanges()

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

Returns:

value or null for none

setAliasIpRanges

public NetworkInterface setAliasIpRanges(List<AliasIpRange> aliasIpRanges)

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.

Parameters:

aliasIpRanges - aliasIpRanges or null for none

getFingerprint

public String getFingerprint()

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Returns:

value or null for none

See Also:

decodeFingerprint()

decodeFingerprint

public byte[] decodeFingerprint()

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getFingerprint()

setFingerprint

public NetworkInterface setFingerprint(String fingerprint)

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Parameters:

fingerprint - fingerprint or null for none

See Also:

#encodeFingerprint()

encodeFingerprint

public NetworkInterface encodeFingerprint(byte[] fingerprint)

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface. The request will fail with error 400 Bad Request if the fingerprint is not provided, or 412 Precondition Failed if the fingerprint is out of date.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getInternalIpv6PrefixLength

public Integer getInternalIpv6PrefixLength()

The prefix length of the primary internal IPv6 range.

Returns:

value or null for none

setInternalIpv6PrefixLength

public NetworkInterface setInternalIpv6PrefixLength(Integer internalIpv6PrefixLength)

The prefix length of the primary internal IPv6 range.

Parameters:

internalIpv6PrefixLength - internalIpv6PrefixLength or null for none

getIpv6AccessConfigs

public List<AccessConfig> getIpv6AccessConfigs()

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

Returns:

value or null for none

setIpv6AccessConfigs

public NetworkInterface setIpv6AccessConfigs(List<AccessConfig> ipv6AccessConfigs)

An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.

Parameters:

ipv6AccessConfigs - ipv6AccessConfigs or null for none

getIpv6AccessType

public String getIpv6AccessType()

[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.

Returns:

value or null for none

setIpv6AccessType

public NetworkInterface setIpv6AccessType(String ipv6AccessType)

[Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.

Parameters:

ipv6AccessType - ipv6AccessType or null for none

getIpv6Address

public String getIpv6Address()

An IPv6 internal network address for this network interface.

Returns:

value or null for none

setIpv6Address

public NetworkInterface setIpv6Address(String ipv6Address)

An IPv6 internal network address for this network interface.

Parameters:

ipv6Address - ipv6Address or null for none

getKind

public String getKind()

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

Returns:

value or null for none

setKind

public NetworkInterface setKind(String kind)

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.

Parameters:

kind - kind or null for none

getName

public String getName()

[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.

Returns:

value or null for none

setName

public NetworkInterface setName(String name)

[Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.

Parameters:

name - name or null for none

getNetwork

public String getNetwork()

URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Returns:

value or null for none

setNetwork

public NetworkInterface setNetwork(String network)

URL of the VPC network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used. If the selected project doesn't have the default network, you must specify a network or subnet. If the network is not specified but the subnetwork is specified, the network is inferred. If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/global/networks/ network - projects/project/global/networks/network - global/networks/default

Parameters:

network - network or null for none

getNetworkIP

public String getNetworkIP()

An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

Returns:

value or null for none

setNetworkIP

public NetworkInterface setNetworkIP(String networkIP)

An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.

Parameters:

networkIP - networkIP or null for none

getNicType

public String getNicType()

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Returns:

value or null for none

setNicType

public NetworkInterface setNicType(String nicType)

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

Parameters:

nicType - nicType or null for none

getQueueCount

public Integer getQueueCount()

The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

Returns:

value or null for none

setQueueCount

public NetworkInterface setQueueCount(Integer queueCount)

The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.

Parameters:

queueCount - queueCount or null for none

getStackType

public String getStackType()

The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at instance creation and update network interface operations.

Returns:

value or null for none

setStackType

public NetworkInterface setStackType(String stackType)

The stack type for this network interface to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at instance creation and update network interface operations.

Parameters:

stackType - stackType or null for none

getSubnetwork

public String getSubnetwork()

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Returns:

value or null for none

setSubnetwork

public NetworkInterface setSubnetwork(String subnetwork)

The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/regions/region /subnetworks/subnetwork - regions/region/subnetworks/subnetwork

Parameters:

subnetwork - subnetwork or null for none

set

public NetworkInterface set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public NetworkInterface clone()

Overrides:

clone in class GenericJson