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.



28039
28040
28041
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28039

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:



27901
27902
27903
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27901

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:



27907
27908
27909
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27907

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) 


27917
27918
27919
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27917

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) 


27922
27923
27924
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27922

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:



27929
27930
27931
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27929

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) 


27936
27937
27938
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27936

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) 


27944
27945
27946
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27944

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) 


27950
27951
27952
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27950

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) 


27957
27958
27959
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27957

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) 


27970
27971
27972
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27970

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) 


27977
27978
27979
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27977

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) 


27984
27985
27986
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27984

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) 


27989
27990
27991
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27989

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) 


27995
27996
27997
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 27995

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) 


28002
28003
28004
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28002

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) 


28010
28011
28012
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28010

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:



28018
28019
28020
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28018

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) 


28030
28031
28032
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28030

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) 


28037
28038
28039
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28037

def vlan
  @vlan
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



28044
28045
28046
28047
28048
28049
28050
28051
28052
28053
28054
28055
28056
28057
28058
28059
28060
28061
28062
28063
28064
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 28044

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