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.



26694
26695
26696
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26694

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 anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or disabled). Corresponds to the JSON property advancedMachineFeatures

Returns:



26546
26547
26548
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26546

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 tofalse. See theEnable IP forwarding documentation for more information. Corresponds to the JSON property canIpForward

Returns:

  • (Boolean) 


26557
26558
26559
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26557

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:



26563
26564
26565
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26563

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) 


26569
26570
26571
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26569

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:



26575
26576
26577
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26575

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:



26581
26582
26583
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26581

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) 


26587
26588
26589
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26587

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>) 


26592
26593
26594
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26592

def labels
  @labels
end

#local_ssd_encryption_mode ⇒ String

Specifies which method should be used for encrypting the Local SSDs attached to the VM. Corresponds to the JSON property localSsdEncryptionMode

Returns:

  • (String) 


26598
26599
26600
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26598

def local_ssd_encryption_mode
  @local_ssd_encryption_mode
end

#machine_type ⇒ String

The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4. If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4, the request will result in an INTERNAL_ERROR. Corresponds to the JSON property machineType

Returns:

  • (String) 


26608
26609
26610
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26608

def machine_type
  @machine_type
end

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

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

Returns:



26613
26614
26615
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26613

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 asminCpuPlatform: "Intel Haswell" orminCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. Corresponds to the JSON property minCpuPlatform

Returns:

  • (String) 


26623
26624
26625
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26623

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:



26628
26629
26630
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26628

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:



26633
26634
26635
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26633

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) 


26640
26641
26642
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26640

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:



26645
26646
26647
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26645

def reservation_affinity
  @reservation_affinity
end

#resource_manager_tags ⇒ Hash<String,String>

Input only. Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/tag_key_idand `tagValues/`tag_value_id or in namespaced format such as org_id|project_id`/`tag_key_short_name and tag_value_short_name. The field is ignored (both PUT & PATCH) when empty. Corresponds to the JSON property resourceManagerTags

Returns:

  • (Hash<String,String>) 


26657
26658
26659
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26657

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>) 


26664
26665
26666
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26664

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:



26669
26670
26671
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26669

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:



26677
26678
26679
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26677

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:



26682
26683
26684
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26682

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:



26687
26688
26689
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26687

def tags
  @tags
end

#workload_identity_config ⇒ Google::Apis::ComputeV1::WorkloadIdentityConfig

Corresponds to the JSON property workloadIdentityConfig

Returns:



26692
26693
26694
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26692

def workload_identity_config
  @workload_identity_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



26699
26700
26701
26702
26703
26704
26705
26706
26707
26708
26709
26710
26711
26712
26713
26714
26715
26716
26717
26718
26719
26720
26721
26722
26723
 
# File 'lib/google/apis/compute_v1/classes.rb', line 26699

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)
  @local_ssd_encryption_mode = args[:local_ssd_encryption_mode] if args.key?(:local_ssd_encryption_mode)
  @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)
  @workload_identity_config = args[:workload_identity_config] if args.key?(:workload_identity_config)
end