Class: Google::Apis::ComputeAlpha::InstanceProperties

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ InstanceProperties

Returns a new instance of InstanceProperties.



32109
32110
32111
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32109

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

Instance Attribute Details

#advanced_machine_features ⇒ Google::Apis::ComputeAlpha::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:



31917
31918
31919
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31917

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) 


31928
31929
31930
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31928

def can_ip_forward
  @can_ip_forward
end

#confidential_instance_config ⇒ Google::Apis::ComputeAlpha::ConfidentialInstanceConfig

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

Returns:



31934
31935
31936
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31934

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) 


31940
31941
31942
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31940

def description
  @description
end

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

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

Returns:



31946
31947
31948
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31946

def disks
  @disks
end

#display_device ⇒ Google::Apis::ComputeAlpha::DisplayDevice

A set of Display Device options Corresponds to the JSON property displayDevice

Returns:



31951
31952
31953
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31951

def display_device
  @display_device
end

#guest_accelerators ⇒ Array<Google::Apis::ComputeAlpha::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:



31957
31958
31959
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31957

def guest_accelerators
  @guest_accelerators
end

#identity ⇒ String

Corresponds to the JSON property identity

Returns:

  • (String) 


31962
31963
31964
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31962

def identity
  @identity
end

#identity_certificate ⇒ Boolean Also known as: identity_certificate?

Corresponds to the JSON property identityCertificate

Returns:

  • (Boolean) 


31967
31968
31969
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31967

def identity_certificate
  @identity_certificate
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) 


31974
31975
31976
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31974

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


31979
31980
31981
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31979

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) 


31985
31986
31987
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31985

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) 


31995
31996
31997
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 31995

def machine_type
  @machine_type
end

#metadata ⇒ Google::Apis::ComputeAlpha::Metadata

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

Returns:



32000
32001
32002
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32000

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) 


32010
32011
32012
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32010

def min_cpu_platform
  @min_cpu_platform
end

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

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

Returns:



32015
32016
32017
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32015

def network_interfaces
  @network_interfaces
end

#network_performance_config ⇒ Google::Apis::ComputeAlpha::NetworkPerformanceConfig

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

Returns:



32020
32021
32022
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32020

def network_performance_config
  @network_performance_config
end

#partner_metadata ⇒ Hash<String,Google::Apis::ComputeAlpha::StructuredEntries>

Partner Metadata assigned to the instance properties. A map from a subdomain (namespace) to entries map. Corresponds to the JSON property partnerMetadata

Returns:



32026
32027
32028
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32026

def partner_metadata
  @partner_metadata
end

#post_key_revocation_action_type ⇒ String

PostKeyRevocationActionType of the instance. Corresponds to the JSON property postKeyRevocationActionType

Returns:

  • (String) 


32031
32032
32033
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32031

def post_key_revocation_action_type
  @post_key_revocation_action_type
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) 


32038
32039
32040
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32038

def private_ipv6_google_access
  @private_ipv6_google_access
end

#reservation_affinity ⇒ Google::Apis::ComputeAlpha::ReservationAffinity

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

Returns:



32043
32044
32045
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32043

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


32055
32056
32057
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32055

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


32062
32063
32064
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32062

def resource_policies
  @resource_policies
end

#scheduling ⇒ Google::Apis::ComputeAlpha::Scheduling

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

Returns:



32067
32068
32069
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32067

def scheduling
  @scheduling
end

#secure_tags ⇒ Array<String>

[Input Only] Secure tags to apply to this instance. Maximum number of secure tags allowed is 50. Note that for MachineImage, this is not supported yet. Corresponds to the JSON property secureTags

Returns:

  • (Array<String>) 


32074
32075
32076
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32074

def secure_tags
  @secure_tags
end

#service_accounts ⇒ Array<Google::Apis::ComputeAlpha::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:



32082
32083
32084
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32082

def service_accounts
  @service_accounts
end

#service_integration_specs ⇒ Hash<String,Google::Apis::ComputeAlpha::ServiceIntegrationSpec>

Mapping of user defined keys to ServiceIntegrationSpec. Corresponds to the JSON property serviceIntegrationSpecs

Returns:



32087
32088
32089
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32087

def service_integration_specs
  @service_integration_specs
end

#shielded_instance_config ⇒ Google::Apis::ComputeAlpha::ShieldedInstanceConfig

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

Returns:



32092
32093
32094
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32092

def shielded_instance_config
  @shielded_instance_config
end

#shielded_vm_config ⇒ Google::Apis::ComputeAlpha::ShieldedVmConfig

A set of Shielded VM options. Corresponds to the JSON property shieldedVmConfig

Returns:



32097
32098
32099
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32097

def shielded_vm_config
  @shielded_vm_config
end

#tags ⇒ Google::Apis::ComputeAlpha::Tags

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

Returns:



32102
32103
32104
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32102

def tags
  @tags
end

#workload_identity_config ⇒ Google::Apis::ComputeAlpha::WorkloadIdentityConfig

Corresponds to the JSON property workloadIdentityConfig

Returns:



32107
32108
32109
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32107

def workload_identity_config
  @workload_identity_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32114
32115
32116
32117
32118
32119
32120
32121
32122
32123
32124
32125
32126
32127
32128
32129
32130
32131
32132
32133
32134
32135
32136
32137
32138
32139
32140
32141
32142
32143
32144
32145
32146
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32114

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)
  @display_device = args[:display_device] if args.key?(:display_device)
  @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
  @identity = args[:identity] if args.key?(:identity)
  @identity_certificate = args[:identity_certificate] if args.key?(:identity_certificate)
  @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)
  @partner_metadata = args[:partner_metadata] if args.key?(:partner_metadata)
  @post_key_revocation_action_type = args[:post_key_revocation_action_type] if args.key?(:post_key_revocation_action_type)
  @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)
  @secure_tags = args[:secure_tags] if args.key?(:secure_tags)
  @service_accounts = args[:service_accounts] if args.key?(:service_accounts)
  @service_integration_specs = args[:service_integration_specs] if args.key?(:service_integration_specs)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @shielded_vm_config = args[:shielded_vm_config] if args.key?(:shielded_vm_config)
  @tags = args[:tags] if args.key?(:tags)
  @workload_identity_config = args[:workload_identity_config] if args.key?(:workload_identity_config)
end