Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class NetworkInterface.
A network interface resource attached to an instance.
s
Generated from protobuf message google.cloud.backupdr.v1.NetworkInterface
Namespace
Google \ Cloud \ BackupDR \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ network |
string
Optional. URL of the VPC network resource for this instance. |
↳ subnetwork |
string
Optional. The URL of the Subnetwork resource for this instance. |
↳ ip_address |
string
Optional. 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. |
↳ ipv6_address |
string
Optional. 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. |
↳ internal_ipv6_prefix_length |
int
Optional. The prefix length of the primary internal IPv6 range. |
↳ name |
string
Output only. [Output Only] The name of the network interface, which is generated by the server. |
↳ access_configs |
array<AccessConfig>
Optional. 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. |
↳ ipv6_access_configs |
array<AccessConfig>
Optional. 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. |
↳ alias_ip_ranges |
array<AliasIpRange>
Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. |
↳ stack_type |
int
The stack type for this network interface. |
↳ ipv6_access_type |
int
Optional. [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. |
↳ queue_count |
int
Optional. 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. |
↳ nic_type |
int
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. |
↳ network_attachment |
string
Optional. 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}. |
getNetwork
Optional. URL of the VPC network resource for this instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasNetwork
clearNetwork
setNetwork
Optional. URL of the VPC network resource for this instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubnetwork
Optional. The URL of the Subnetwork resource for this instance.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSubnetwork
clearSubnetwork
setSubnetwork
Optional. The URL of the Subnetwork resource for this instance.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIpAddress
Optional. 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 | |
|---|---|
| Type | Description |
string |
|
hasIpAddress
clearIpAddress
setIpAddress
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIpv6Address
Optional. 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasIpv6Address
clearIpv6Address
setIpv6Address
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInternalIpv6PrefixLength
Optional. The prefix length of the primary internal IPv6 range.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasInternalIpv6PrefixLength
clearInternalIpv6PrefixLength
setInternalIpv6PrefixLength
Optional. The prefix length of the primary internal IPv6 range.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Output only. [Output Only] The name of the network interface, which is generated by the server.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasName
clearName
setName
Output only. [Output Only] The name of the network interface, which is generated by the server.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAccessConfigs
Optional. 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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAccessConfigs
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AccessConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIpv6AccessConfigs
Optional. 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 | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setIpv6AccessConfigs
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AccessConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAliasIpRanges
Optional. An array of alias IP ranges for this network interface.
You can only specify this field for network interfaces in VPC networks.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAliasIpRanges
Optional. An array of alias IP ranges for this network interface.
You can only specify this field for network interfaces in VPC networks.
| Parameter | |
|---|---|
| Name | Description |
var |
array<AliasIpRange>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStackType
The stack type for this network interface.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasStackType
clearStackType
setStackType
The stack type for this network interface.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIpv6AccessType
Optional. [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.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasIpv6AccessType
clearIpv6AccessType
setIpv6AccessType
Optional. [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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueueCount
Optional. 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 | |
|---|---|
| Type | Description |
int |
|
hasQueueCount
clearQueueCount
setQueueCount
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasNicType
clearNicType
setNicType
Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNetworkAttachment
Optional. 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}.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasNetworkAttachment
clearNetworkAttachment
setNetworkAttachment
Optional. 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}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|