Class: Google::Apis::ComputeV1::InstanceProperties

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceProperties

Returns a new instance of InstanceProperties.



16060
16061
16062
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16060

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

Instance Attribute Details

#advanced_machine_features ⇒ Google::Apis::ComputeV1::AdvancedMachineFeatures

Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). Corresponds to the JSON property advancedMachineFeatures

Returns:



15935
15936
15937
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15935

def advanced_machine_features
  @advanced_machine_features
end

#can_ip_forward ⇒ Boolean Also known as: can_ip_forward?

Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. Corresponds to the JSON property canIpForward

Returns:

  • (Boolean) 


15945
15946
15947
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15945

def can_ip_forward
  @can_ip_forward
end

#confidential_instance_config ⇒ Google::Apis::ComputeV1::ConfidentialInstanceConfig

A set of Confidential Instance options. Corresponds to the JSON property confidentialInstanceConfig

Returns:



15951
15952
15953
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15951

def confidential_instance_config
  @confidential_instance_config
end

#description ⇒ String

An optional text description for the instances that are created from these properties. Corresponds to the JSON property description

Returns:

  • (String) 


15957
15958
15959
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15957

def description
  @description
end

#disks ⇒ Array<Google::Apis::ComputeV1::AttachedDisk>

An array of disks that are associated with the instances that are created from these properties. Corresponds to the JSON property disks

Returns:



15963
15964
15965
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15963

def disks
  @disks
end

#guest_accelerators ⇒ Array<Google::Apis::ComputeV1::AcceleratorConfig>

A list of guest accelerator cards' type and count to use for instances created from these properties. Corresponds to the JSON property guestAccelerators

Returns:



15969
15970
15971
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15969

def guest_accelerators
  @guest_accelerators
end

#key_revocation_action_type ⇒ String

KeyRevocationActionType of the instance. Supported options are "STOP" and " NONE". The default value is "NONE" if it is not specified. Corresponds to the JSON property keyRevocationActionType

Returns:

  • (String) 


15975
15976
15977
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15975

def key_revocation_action_type
  @key_revocation_action_type
end

#labels ⇒ Hash<String,String>

Labels to apply to instances that are created from these properties. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


15980
15981
15982
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15980

def labels
  @labels
end

#machine_type ⇒ String

The machine type to use for instances that are created from these properties. Corresponds to the JSON property machineType

Returns:

  • (String) 


15985
15986
15987
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15985

def machine_type
  @machine_type
end

#metadata ⇒ Google::Apis::ComputeV1::Metadata

A metadata key/value entry. Corresponds to the JSON property metadata

Returns:



15990
15991
15992
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15990

def metadata
  @metadata
end

#min_cpu_platform ⇒ String

Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: " Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. Corresponds to the JSON property minCpuPlatform

Returns:

  • (String) 


15999
16000
16001
 
# File 'lib/google/apis/compute_v1/classes.rb', line 15999

def min_cpu_platform
  @min_cpu_platform
end

#network_interfaces ⇒ Array<Google::Apis::ComputeV1::NetworkInterface>

An array of network access configurations for this interface. Corresponds to the JSON property networkInterfaces

Returns:



16004
16005
16006
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16004

def network_interfaces
  @network_interfaces
end

#network_performance_config ⇒ Google::Apis::ComputeV1::NetworkPerformanceConfig

Note that for MachineImage, this is not supported yet. Corresponds to the JSON property networkPerformanceConfig

Returns:



16009
16010
16011
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16009

def network_performance_config
  @network_performance_config
end

#private_ipv6_google_access ⇒ String

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. Corresponds to the JSON property privateIpv6GoogleAccess

Returns:

  • (String) 


16016
16017
16018
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16016

def private_ipv6_google_access
  @private_ipv6_google_access
end

#reservation_affinity ⇒ Google::Apis::ComputeV1::ReservationAffinity

Specifies the reservations that this instance can consume from. Corresponds to the JSON property reservationAffinity

Returns:



16021
16022
16023
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16021

def reservation_affinity
  @reservation_affinity
end

#resource_manager_tags ⇒ Hash<String,String>

Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/tag_key_id`, and values are in the formattagValues/456. The field is ignored (both PUT & PATCH) when empty. Corresponds to the JSON propertyresourceManagerTags`

Returns:

  • (Hash<String,String>) 


16029
16030
16031
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16029

def resource_manager_tags
  @resource_manager_tags
end

#resource_policies ⇒ Array<String>

Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet. Corresponds to the JSON property resourcePolicies

Returns:

  • (Array<String>) 


16035
16036
16037
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16035

def resource_policies
  @resource_policies
end

#scheduling ⇒ Google::Apis::ComputeV1::Scheduling

Sets the scheduling options for an Instance. Corresponds to the JSON property scheduling

Returns:



16040
16041
16042
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16040

def scheduling
  @scheduling
end

#service_accounts ⇒ Array<Google::Apis::ComputeV1::ServiceAccount>

A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. Corresponds to the JSON property serviceAccounts

Returns:



16048
16049
16050
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16048

def service_accounts
  @service_accounts
end

#shielded_instance_config ⇒ Google::Apis::ComputeV1::ShieldedInstanceConfig

A set of Shielded Instance options. Corresponds to the JSON property shieldedInstanceConfig

Returns:



16053
16054
16055
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16053

def shielded_instance_config
  @shielded_instance_config
end

#tags ⇒ Google::Apis::ComputeV1::Tags

A set of instance tags. Corresponds to the JSON property tags

Returns:



16058
16059
16060
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16058

def tags
  @tags
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
 
# File 'lib/google/apis/compute_v1/classes.rb', line 16065

def update!(**args)
  @advanced_machine_features = args[:advanced_machine_features] if args.key?(:advanced_machine_features)
  @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward)
  @confidential_instance_config = args[:confidential_instance_config] if args.key?(:confidential_instance_config)
  @description = args[:description] if args.key?(:description)
  @disks = args[:disks] if args.key?(:disks)
  @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
  @key_revocation_action_type = args[:key_revocation_action_type] if args.key?(:key_revocation_action_type)
  @labels = args[:labels] if args.key?(:labels)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @metadata = args[:metadata] if args.key?(:metadata)
  @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
  @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces)
  @network_performance_config = args[:network_performance_config] if args.key?(:network_performance_config)
  @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access)
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
  @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @scheduling = args[:scheduling] if args.key?(:scheduling)
  @service_accounts = args[:service_accounts] if args.key?(:service_accounts)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @tags = args[:tags] if args.key?(:tags)
end