English
Deutsch
Español – América Latina
Français
Português – Brasil
中文 – 简体
日本語
한국어

Contact Us Start free

Interface NetworkInterfaceOrBuilder (1.33.0)

public interface NetworkInterfaceOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccessConfigs(int index)

public abstract AccessConfig getAccessConfigs(int index)

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.

repeated .google.cloud.compute.v1.AccessConfig access_configs = 111058326;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AccessConfig`

getAccessConfigsCount()

public abstract int getAccessConfigsCount()

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.

repeated .google.cloud.compute.v1.AccessConfig access_configs = 111058326;

Returns
Type	Description
`int`

getAccessConfigsList()

public abstract List<AccessConfig> getAccessConfigsList()

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.

repeated .google.cloud.compute.v1.AccessConfig access_configs = 111058326;

Returns
Type	Description
`List<AccessConfig>`

getAccessConfigsOrBuilder(int index)

public abstract AccessConfigOrBuilder getAccessConfigsOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.AccessConfig access_configs = 111058326;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AccessConfigOrBuilder`

getAccessConfigsOrBuilderList()

public abstract List<? extends AccessConfigOrBuilder> getAccessConfigsOrBuilderList()

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.

repeated .google.cloud.compute.v1.AccessConfig access_configs = 111058326;

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

getAliasIpRanges(int index)

public abstract AliasIpRange getAliasIpRanges(int index)

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

repeated .google.cloud.compute.v1.AliasIpRange alias_ip_ranges = 165085631;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AliasIpRange`

getAliasIpRangesCount()

public abstract int getAliasIpRangesCount()

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

repeated .google.cloud.compute.v1.AliasIpRange alias_ip_ranges = 165085631;

Returns
Type	Description
`int`

getAliasIpRangesList()

public abstract List<AliasIpRange> getAliasIpRangesList()

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

repeated .google.cloud.compute.v1.AliasIpRange alias_ip_ranges = 165085631;

Returns
Type	Description
`List<AliasIpRange>`

getAliasIpRangesOrBuilder(int index)

public abstract AliasIpRangeOrBuilder getAliasIpRangesOrBuilder(int index)

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

repeated .google.cloud.compute.v1.AliasIpRange alias_ip_ranges = 165085631;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AliasIpRangeOrBuilder`

getAliasIpRangesOrBuilderList()

public abstract List<? extends AliasIpRangeOrBuilder> getAliasIpRangesOrBuilderList()

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

repeated .google.cloud.compute.v1.AliasIpRange alias_ip_ranges = 165085631;

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

getFingerprint()

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

optional string fingerprint = 234678500;

Returns
Type	Description
`String`	The fingerprint.

getFingerprintBytes()

public abstract ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns
Type	Description
`ByteString`	The bytes for fingerprint.

getInternalIpv6PrefixLength()

public abstract int getInternalIpv6PrefixLength()

The prefix length of the primary internal IPv6 range.

optional int32 internal_ipv6_prefix_length = 203833757;

Returns
Type	Description
`int`	The internalIpv6PrefixLength.

getIpv6AccessConfigs(int index)

public abstract AccessConfig getIpv6AccessConfigs(int index)

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.

repeated .google.cloud.compute.v1.AccessConfig ipv6_access_configs = 483472110;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AccessConfig`

getIpv6AccessConfigsCount()

public abstract int getIpv6AccessConfigsCount()

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.

repeated .google.cloud.compute.v1.AccessConfig ipv6_access_configs = 483472110;

Returns
Type	Description
`int`

getIpv6AccessConfigsList()

public abstract List<AccessConfig> getIpv6AccessConfigsList()

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.

repeated .google.cloud.compute.v1.AccessConfig ipv6_access_configs = 483472110;

Returns
Type	Description
`List<AccessConfig>`

getIpv6AccessConfigsOrBuilder(int index)

public abstract AccessConfigOrBuilder getIpv6AccessConfigsOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.AccessConfig ipv6_access_configs = 483472110;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`AccessConfigOrBuilder`

getIpv6AccessConfigsOrBuilderList()

public abstract List<? extends AccessConfigOrBuilder> getIpv6AccessConfigsOrBuilderList()

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.

repeated .google.cloud.compute.v1.AccessConfig ipv6_access_configs = 483472110;

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

getIpv6AccessType()

public abstract 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. Check the Ipv6AccessType enum for the list of possible values.

optional string ipv6_access_type = 504658653;

Returns
Type	Description
`String`	The ipv6AccessType.

getIpv6AccessTypeBytes()

public abstract ByteString getIpv6AccessTypeBytes()

[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. Check the Ipv6AccessType enum for the list of possible values.

optional string ipv6_access_type = 504658653;

Returns
Type	Description
`ByteString`	The bytes for ipv6AccessType.

getIpv6Address()

public abstract String getIpv6Address()

An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.

optional string ipv6_address = 341563804;

Returns
Type	Description
`String`	The ipv6Address.

getIpv6AddressBytes()

public abstract ByteString getIpv6AddressBytes()

An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.

optional string ipv6_address = 341563804;

Returns
Type	Description
`ByteString`	The bytes for ipv6Address.

getKind()

public abstract String getKind()

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

optional string kind = 3292052;

Returns
Type	Description
`String`	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type	Description
`ByteString`	The bytes for kind.

getName()

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

optional string name = 3373707;

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type	Description
`ByteString`	The bytes for name.

getNetwork()

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

optional string network = 232872494;

Returns
Type	Description
`String`	The network.

getNetworkAttachment()

public abstract String getNetworkAttachment()

The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

optional string network_attachment = 224644052;

Returns
Type	Description
`String`	The networkAttachment.

getNetworkAttachmentBytes()

public abstract ByteString getNetworkAttachmentBytes()

The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

optional string network_attachment = 224644052;

Returns
Type	Description
`ByteString`	The bytes for networkAttachment.

getNetworkBytes()

public abstract ByteString getNetworkBytes()

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

optional string network = 232872494;

Returns
Type	Description
`ByteString`	The bytes for network.

getNetworkIP()

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

optional string network_i_p = 207181961;

Returns
Type	Description
`String`	The networkIP.

getNetworkIPBytes()

public abstract ByteString getNetworkIPBytes()

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.

optional string network_i_p = 207181961;

Returns
Type	Description
`ByteString`	The bytes for networkIP.

getNicType()

public abstract String getNicType()

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Check the NicType enum for the list of possible values.

optional string nic_type = 59810577;

Returns
Type	Description
`String`	The nicType.

getNicTypeBytes()

public abstract ByteString getNicTypeBytes()

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Check the NicType enum for the list of possible values.

optional string nic_type = 59810577;

Returns
Type	Description
`ByteString`	The bytes for nicType.

getQueueCount()

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

optional int32 queue_count = 503708769;

Returns
Type	Description
`int`	The queueCount.

getStackType()

public abstract String getStackType()

The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations. Check the StackType enum for the list of possible values.

optional string stack_type = 425908881;

Returns
Type	Description
`String`	The stackType.

getStackTypeBytes()

public abstract ByteString getStackTypeBytes()

The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations. Check the StackType enum for the list of possible values.

optional string stack_type = 425908881;

Returns
Type	Description
`ByteString`	The bytes for stackType.

getSubnetwork()

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

optional string subnetwork = 307827694;

Returns
Type	Description
`String`	The subnetwork.

getSubnetworkBytes()

public abstract ByteString getSubnetworkBytes()

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

optional string subnetwork = 307827694;

Returns
Type	Description
`ByteString`	The bytes for subnetwork.

hasFingerprint()

public abstract boolean hasFingerprint()

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.

optional string fingerprint = 234678500;

Returns
Type	Description
`boolean`	Whether the fingerprint field is set.

hasInternalIpv6PrefixLength()

public abstract boolean hasInternalIpv6PrefixLength()

The prefix length of the primary internal IPv6 range.

optional int32 internal_ipv6_prefix_length = 203833757;

Returns
Type	Description
`boolean`	Whether the internalIpv6PrefixLength field is set.

hasIpv6AccessType()

public abstract boolean hasIpv6AccessType()

[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. Check the Ipv6AccessType enum for the list of possible values.

optional string ipv6_access_type = 504658653;

Returns
Type	Description
`boolean`	Whether the ipv6AccessType field is set.

hasIpv6Address()

public abstract boolean hasIpv6Address()

An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.

optional string ipv6_address = 341563804;

Returns
Type	Description
`boolean`	Whether the ipv6Address field is set.

hasKind()

public abstract boolean hasKind()

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

optional string kind = 3292052;

Returns
Type	Description
`boolean`	Whether the kind field is set.

hasName()

public abstract boolean hasName()

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

optional string name = 3373707;

Returns
Type	Description
`boolean`	Whether the name field is set.

hasNetwork()

public abstract boolean hasNetwork()

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

optional string network = 232872494;

Returns
Type	Description
`boolean`	Whether the network field is set.

hasNetworkAttachment()

public abstract boolean hasNetworkAttachment()

The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.

optional string network_attachment = 224644052;

Returns
Type	Description
`boolean`	Whether the networkAttachment field is set.

hasNetworkIP()

public abstract boolean hasNetworkIP()

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.

optional string network_i_p = 207181961;

Returns
Type	Description
`boolean`	Whether the networkIP field is set.

hasNicType()

public abstract boolean hasNicType()

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Check the NicType enum for the list of possible values.

optional string nic_type = 59810577;

Returns
Type	Description
`boolean`	Whether the nicType field is set.

hasQueueCount()

public abstract boolean hasQueueCount()

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.

optional int32 queue_count = 503708769;

Returns
Type	Description
`boolean`	Whether the queueCount field is set.

hasStackType()

public abstract boolean hasStackType()

The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations. Check the StackType enum for the list of possible values.

optional string stack_type = 425908881;

Returns
Type	Description
`boolean`	Whether the stackType field is set.

hasSubnetwork()

public abstract boolean hasSubnetwork()

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

optional string subnetwork = 307827694;

Returns
Type	Description
`boolean`	Whether the subnetwork field is set.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-12 UTC.