Class: Google::Apis::ComputeBeta::Instance

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

Overview

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



13286
13287
13288
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13286

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

Instance Attribute Details

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



12985
12986
12987
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12985

def advanced_machine_features
  @advanced_machine_features
end

#can_ip_forward ⇒ Boolean Also known as: can_ip_forward?

Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding . Corresponds to the JSON property canIpForward

Returns:

  • (Boolean) 


12992
12993
12994
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12992

def can_ip_forward
  @can_ip_forward
end

#confidential_instance_config ⇒ Google::Apis::ComputeBeta::ConfidentialInstanceConfig

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

Returns:



12998
12999
13000
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12998

def confidential_instance_config
  @confidential_instance_config
end

#cpu_platform ⇒ String

[Output Only] The CPU platform used by this instance. Corresponds to the JSON property cpuPlatform

Returns:

  • (String) 


13003
13004
13005
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13003

def cpu_platform
  @cpu_platform
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


13008
13009
13010
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13008

def creation_timestamp
  @creation_timestamp
end

#deletion_protection ⇒ Boolean Also known as: deletion_protection?

Whether the resource should be protected against deletion. Corresponds to the JSON property deletionProtection

Returns:

  • (Boolean) 


13013
13014
13015
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13013

def deletion_protection
  @deletion_protection
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


13020
13021
13022
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13020

def description
  @description
end

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

Array of disks associated with this instance. Persistent disks must be created before you can assign them. Corresponds to the JSON property disks

Returns:



13026
13027
13028
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13026

def disks
  @disks
end

#display_device ⇒ Google::Apis::ComputeBeta::DisplayDevice

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

Returns:



13031
13032
13033
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13031

def display_device
  @display_device
end

#erase_windows_vss_signature ⇒ Boolean Also known as: erase_windows_vss_signature?

Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. Corresponds to the JSON property eraseWindowsVssSignature

Returns:

  • (Boolean) 


13037
13038
13039
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13037

def erase_windows_vss_signature
  @erase_windows_vss_signature
end

#fingerprint ⇒ String

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


13049
13050
13051
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13049

def fingerprint
  @fingerprint
end

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

A list of the type and count of accelerator cards attached to the instance. Corresponds to the JSON property guestAccelerators

Returns:



13054
13055
13056
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13054

def guest_accelerators
  @guest_accelerators
end

#hostname ⇒ String

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [ INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [ INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. Corresponds to the JSON property hostname

Returns:

  • (String) 


13062
13063
13064
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13062

def hostname
  @hostname
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


13068
13069
13070
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13068

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


13074
13075
13076
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13074

def key_revocation_action_type
  @key_revocation_action_type
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#instance for instances. Corresponds to the JSON property kind

Returns:

  • (String) 


13079
13080
13081
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13079

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


13090
13091
13092
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13090

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels to apply to this instance. These can be later modified by the setLabels method. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


13096
13097
13098
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13096

def labels
  @labels
end

#last_start_timestamp ⇒ String

[Output Only] Last start timestamp in RFC3339 text format. Corresponds to the JSON property lastStartTimestamp

Returns:

  • (String) 


13101
13102
13103
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13101

def last_start_timestamp
  @last_start_timestamp
end

#last_stop_timestamp ⇒ String

[Output Only] Last stop timestamp in RFC3339 text format. Corresponds to the JSON property lastStopTimestamp

Returns:

  • (String) 


13106
13107
13108
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13106

def last_stop_timestamp
  @last_stop_timestamp
end

#last_suspended_timestamp ⇒ String

[Output Only] Last suspended timestamp in RFC3339 text format. Corresponds to the JSON property lastSuspendedTimestamp

Returns:

  • (String) 


13111
13112
13113
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13111

def last_suspended_timestamp
  @last_suspended_timestamp
end

#machine_type ⇒ String

Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1- standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/ machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. Corresponds to the JSON property machineType

Returns:

  • (String) 


13126
13127
13128
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13126

def machine_type
  @machine_type
end

#metadata ⇒ Google::Apis::ComputeBeta::Metadata

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

Returns:



13131
13132
13133
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13131

def metadata
  @metadata
end

#min_cpu_platform ⇒ String

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". Corresponds to the JSON property minCpuPlatform

Returns:

  • (String) 


13138
13139
13140
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13138

def min_cpu_platform
  @min_cpu_platform
end

#name ⇒ String

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


13149
13150
13151
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13149

def name
  @name
end

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

An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. Corresponds to the JSON property networkInterfaces

Returns:



13156
13157
13158
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13156

def network_interfaces
  @network_interfaces
end

#network_performance_config ⇒ Google::Apis::ComputeBeta::NetworkPerformanceConfig

Corresponds to the JSON property networkPerformanceConfig

Returns:



13161
13162
13163
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13161

def network_performance_config
  @network_performance_config
end

#params ⇒ Google::Apis::ComputeBeta::InstanceParams

Additional instance params. Corresponds to the JSON property params

Returns:



13166
13167
13168
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13166

def params
  @params
end

#post_key_revocation_action_type ⇒ String

PostKeyRevocationActionType of the instance. Corresponds to the JSON property postKeyRevocationActionType

Returns:

  • (String) 


13171
13172
13173
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13171

def post_key_revocation_action_type
  @post_key_revocation_action_type
end

#private_ipv6_google_access ⇒ String

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Corresponds to the JSON property privateIpv6GoogleAccess

Returns:

  • (String) 


13177
13178
13179
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13177

def private_ipv6_google_access
  @private_ipv6_google_access
end

#reservation_affinity ⇒ Google::Apis::ComputeBeta::ReservationAffinity

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

Returns:



13182
13183
13184
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13182

def reservation_affinity
  @reservation_affinity
end

#resource_policies ⇒ Array<String>

Resource policies applied to this instance. Corresponds to the JSON property resourcePolicies

Returns:

  • (Array<String>) 


13187
13188
13189
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13187

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeBeta::ResourceStatus

Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. Corresponds to the JSON property resourceStatus

Returns:



13194
13195
13196
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13194

def resource_status
  @resource_status
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


13199
13200
13201
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13199

def satisfies_pzs
  @satisfies_pzs
end

#scheduling ⇒ Google::Apis::ComputeBeta::Scheduling

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

Returns:



13205
13206
13207
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13205

def scheduling
  @scheduling
end

#self_link ⇒ String

[Output Only] Server-defined URL for this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


13210
13211
13212
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13210

def self_link
  @self_link
end

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

A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. Corresponds to the JSON property serviceAccounts

Returns:



13219
13220
13221
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13219

def service_accounts
  @service_accounts
end

#shielded_instance_config ⇒ Google::Apis::ComputeBeta::ShieldedInstanceConfig

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

Returns:



13224
13225
13226
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13224

def shielded_instance_config
  @shielded_instance_config
end

#shielded_instance_integrity_policy ⇒ Google::Apis::ComputeBeta::ShieldedInstanceIntegrityPolicy

The policy describes the baseline against which Instance boot integrity is measured. Corresponds to the JSON property shieldedInstanceIntegrityPolicy

Returns:



13230
13231
13232
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13230

def shielded_instance_integrity_policy
  @shielded_instance_integrity_policy
end

#shielded_vm_config ⇒ Google::Apis::ComputeBeta::ShieldedVmConfig

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

Returns:



13235
13236
13237
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13235

def shielded_vm_config
  @shielded_vm_config
end

#shielded_vm_integrity_policy ⇒ Google::Apis::ComputeBeta::ShieldedVmIntegrityPolicy

The policy describes the baseline against which VM instance boot integrity is measured. Corresponds to the JSON property shieldedVmIntegrityPolicy

Returns:



13241
13242
13243
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13241

def shielded_vm_integrity_policy
  @shielded_vm_integrity_policy
end

#source_machine_image ⇒ String

Source machine image Corresponds to the JSON property sourceMachineImage

Returns:

  • (String) 


13246
13247
13248
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13246

def source_machine_image
  @source_machine_image
end

#source_machine_image_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Source machine image encryption key when creating an instance from a machine image. Corresponds to the JSON property sourceMachineImageEncryptionKey

Returns:



13252
13253
13254
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13252

def source_machine_image_encryption_key
  @source_machine_image_encryption_key
end

#start_restricted ⇒ Boolean Also known as: start_restricted?

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. Corresponds to the JSON property startRestricted

Returns:

  • (Boolean) 


13258
13259
13260
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13258

def start_restricted
  @start_restricted
end

#status ⇒ String

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Corresponds to the JSON property status

Returns:

  • (String) 


13267
13268
13269
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13267

def status
  @status
end

#status_message ⇒ String

[Output Only] An optional, human-readable explanation of the status. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


13272
13273
13274
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13272

def status_message
  @status_message
end

#tags ⇒ Google::Apis::ComputeBeta::Tags

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

Returns:



13277
13278
13279
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13277

def tags
  @tags
end

#zone ⇒ String

[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property zone

Returns:

  • (String) 


13284
13285
13286
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13284

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
 
# File 'lib/google/apis/compute_beta/classes.rb', line 13291

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)
  @cpu_platform = args[:cpu_platform] if args.key?(:cpu_platform)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection)
  @description = args[:description] if args.key?(:description)
  @disks = args[:disks] if args.key?(:disks)
  @display_device = args[:display_device] if args.key?(:display_device)
  @erase_windows_vss_signature = args[:erase_windows_vss_signature] if args.key?(:erase_windows_vss_signature)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
  @hostname = args[:hostname] if args.key?(:hostname)
  @id = args[:id] if args.key?(:id)
  @key_revocation_action_type = args[:key_revocation_action_type] if args.key?(:key_revocation_action_type)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @last_start_timestamp = args[:last_start_timestamp] if args.key?(:last_start_timestamp)
  @last_stop_timestamp = args[:last_stop_timestamp] if args.key?(:last_stop_timestamp)
  @last_suspended_timestamp = args[:last_suspended_timestamp] if args.key?(:last_suspended_timestamp)
  @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)
  @name = args[:name] if args.key?(:name)
  @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces)
  @network_performance_config = args[:network_performance_config] if args.key?(:network_performance_config)
  @params = args[:params] if args.key?(:params)
  @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_policies = args[:resource_policies] if args.key?(:resource_policies)
  @resource_status = args[:resource_status] if args.key?(:resource_status)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @scheduling = args[:scheduling] if args.key?(:scheduling)
  @self_link = args[:self_link] if args.key?(:self_link)
  @service_accounts = args[:service_accounts] if args.key?(:service_accounts)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @shielded_instance_integrity_policy = args[:shielded_instance_integrity_policy] if args.key?(:shielded_instance_integrity_policy)
  @shielded_vm_config = args[:shielded_vm_config] if args.key?(:shielded_vm_config)
  @shielded_vm_integrity_policy = args[:shielded_vm_integrity_policy] if args.key?(:shielded_vm_integrity_policy)
  @source_machine_image = args[:source_machine_image] if args.key?(:source_machine_image)
  @source_machine_image_encryption_key = args[:source_machine_image_encryption_key] if args.key?(:source_machine_image_encryption_key)
  @start_restricted = args[:start_restricted] if args.key?(:start_restricted)
  @status = args[:status] if args.key?(:status)
  @status_message = args[:status_message] if args.key?(:status_message)
  @tags = args[:tags] if args.key?(:tags)
  @zone = args[:zone] if args.key?(:zone)
end