Class: Google::Apis::ComputeAlpha::NetworkInterface

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

A network interface resource attached to an instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NetworkInterface

Returns a new instance of NetworkInterface.



28691
28692
28693
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28691

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access_configs ⇒ Array<Google::Apis::ComputeAlpha::AccessConfig>

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. Corresponds to the JSON property accessConfigs

Returns:



28553
28554
28555
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28553

def access_configs
  @access_configs
end

#alias_ip_ranges ⇒ Array<Google::Apis::ComputeAlpha::AliasIpRange>

An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. Corresponds to the JSON property aliasIpRanges

Returns:



28559
28560
28561
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28559

def alias_ip_ranges
  @alias_ip_ranges
end

#fingerprint ⇒ String

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. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


28569
28570
28571
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28569

def fingerprint
  @fingerprint
end

#internal_ipv6_prefix_length ⇒ Fixnum

The prefix length of the primary internal IPv6 range. Corresponds to the JSON property internalIpv6PrefixLength

Returns:

  • (Fixnum) 


28574
28575
28576
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28574

def internal_ipv6_prefix_length
  @internal_ipv6_prefix_length
end

#ipv6_access_configs ⇒ Array<Google::Apis::ComputeAlpha::AccessConfig>

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. Corresponds to the JSON property ipv6AccessConfigs

Returns:



28581
28582
28583
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28581

def ipv6_access_configs
  @ipv6_access_configs
end

#ipv6_access_type ⇒ String

[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. Corresponds to the JSON property ipv6AccessType

Returns:

  • (String) 


28588
28589
28590
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28588

def ipv6_access_type
  @ipv6_access_type
end

#ipv6_address ⇒ String

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. Corresponds to the JSON property ipv6Address

Returns:

  • (String) 


28596
28597
28598
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28596

def ipv6_address
  @ipv6_address
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#networkInterface for network interfaces. Corresponds to the JSON property kind

Returns:

  • (String) 


28602
28603
28604
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28602

def kind
  @kind
end

#name ⇒ String

[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. Corresponds to the JSON property name

Returns:

  • (String) 


28609
28610
28611
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28609

def name
  @name
end

#network ⇒ String

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 Corresponds to the JSON property network

Returns:

  • (String) 


28622
28623
28624
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28622

def network
  @network
end

#network_attachment ⇒ String

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. Corresponds to the JSON property networkAttachment

Returns:

  • (String) 


28629
28630
28631
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28629

def network_attachment
  @network_attachment
end

#network_ip ⇒ String

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. Corresponds to the JSON property networkIP

Returns:

  • (String) 


28636
28637
28638
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28636

def network_ip
  @network_ip
end

#nic_type ⇒ String

The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. Corresponds to the JSON property nicType

Returns:

  • (String) 


28641
28642
28643
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28641

def nic_type
  @nic_type
end

#parent_nic_name ⇒ String

Name of the parent network interface of a VLAN based nic. If this field is specified, vlan must be set. Corresponds to the JSON property parentNicName

Returns:

  • (String) 


28647
28648
28649
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28647

def parent_nic_name
  @parent_nic_name
end

#queue_count ⇒ Fixnum

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. Corresponds to the JSON property queueCount

Returns:

  • (Fixnum) 


28654
28655
28656
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28654

def queue_count
  @queue_count
end

#stack_type ⇒ String

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. Corresponds to the JSON property stackType

Returns:

  • (String) 


28662
28663
28664
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28662

def stack_type
  @stack_type
end

#subinterfaces ⇒ Array<Google::Apis::ComputeAlpha::NetworkInterfaceSubInterface>

SubInterfaces help enable L2 communication for the instance over subnetworks that support L2. Every network interface will get a default untagged (vlan not specified) subinterface. Users can specify additional tagged subinterfaces which are sub-fields to the Network Interface. Corresponds to the JSON property subinterfaces

Returns:



28670
28671
28672
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28670

def subinterfaces
  @subinterfaces
end

#subnetwork ⇒ String

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 Corresponds to the JSON property subnetwork

Returns:

  • (String) 


28682
28683
28684
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28682

def subnetwork
  @subnetwork
end

#vlan ⇒ Fixnum

VLAN tag of a VLAN based network interface, must be in range from 2 to 4094 inclusively. This field is mandatory if the parent network interface name is set. Corresponds to the JSON property vlan

Returns:

  • (Fixnum) 


28689
28690
28691
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28689

def vlan
  @vlan
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28696
28697
28698
28699
28700
28701
28702
28703
28704
28705
28706
28707
28708
28709
28710
28711
28712
28713
28714
28715
28716
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28696

def update!(**args)
  @access_configs = args[:access_configs] if args.key?(:access_configs)
  @alias_ip_ranges = args[:alias_ip_ranges] if args.key?(:alias_ip_ranges)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @internal_ipv6_prefix_length = args[:internal_ipv6_prefix_length] if args.key?(:internal_ipv6_prefix_length)
  @ipv6_access_configs = args[:ipv6_access_configs] if args.key?(:ipv6_access_configs)
  @ipv6_access_type = args[:ipv6_access_type] if args.key?(:ipv6_access_type)
  @ipv6_address = args[:ipv6_address] if args.key?(:ipv6_address)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @network_attachment = args[:network_attachment] if args.key?(:network_attachment)
  @network_ip = args[:network_ip] if args.key?(:network_ip)
  @nic_type = args[:nic_type] if args.key?(:nic_type)
  @parent_nic_name = args[:parent_nic_name] if args.key?(:parent_nic_name)
  @queue_count = args[:queue_count] if args.key?(:queue_count)
  @stack_type = args[:stack_type] if args.key?(:stack_type)
  @subinterfaces = args[:subinterfaces] if args.key?(:subinterfaces)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @vlan = args[:vlan] if args.key?(:vlan)
end