Class: Google::Apis::ComputeAlpha::Instance

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

Overview

An Instance resource. (== resource_for beta.instances ==) (== resource_for v1. instances ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance



10370
10371
10372
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10370

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

Instance Attribute Details

#allocation_affinity ⇒ Google::Apis::ComputeAlpha::AllocationAffinity

AllocationAffinity is the configuration of desired allocation which this instance could take capacity from. Corresponds to the JSON property allocationAffinity

Returns:



10151
10152
10153
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10151

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


10158
10159
10160
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10158

def can_ip_forward
  @can_ip_forward
end

#cpu_platform ⇒ String

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

Returns:

  • (String) 


10164
10165
10166
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10164

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) 


10169
10170
10171
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10169

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) 


10174
10175
10176
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10174

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) 


10181
10182
10183
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10181

def description
  @description
end

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



10187
10188
10189
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10187

def disks
  @disks
end

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

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

Returns:



10192
10193
10194
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10192

def display_device
  @display_device
end

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

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

Returns:



10197
10198
10199
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10197

def guest_accelerators
  @guest_accelerators
end

#hostname ⇒ String

Corresponds to the JSON property hostname

Returns:

  • (String) 


10202
10203
10204
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10202

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) 


10208
10209
10210
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10208

def id
  @id
end

#instance_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property instanceEncryptionKey

Returns:



10213
10214
10215
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10213

def instance_encryption_key
  @instance_encryption_key
end

#kind ⇒ String

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

Returns:

  • (String) 


10218
10219
10220
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10218

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) 


10229
10230
10231
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10229

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


10235
10236
10237
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10235

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


10252
10253
10254
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10252

def machine_type
  @machine_type
end

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

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

Returns:



10257
10258
10259
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10257

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) 


10264
10265
10266
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10264

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) 


10275
10276
10277
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10275

def name
  @name
end

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



10282
10283
10284
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10282

def network_interfaces
  @network_interfaces
end

#preserved_state_size_gb ⇒ Fixnum

Total amount of preserved state for SUSPENDED instances. Read-only in the api. Corresponds to the JSON property preservedStateSizeGb

Returns:

  • (Fixnum) 


10287
10288
10289
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10287

def preserved_state_size_gb
  @preserved_state_size_gb
end

#resource_policies ⇒ Array<String>

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

Returns:

  • (Array<String>) 


10292
10293
10294
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10292

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:



10297
10298
10299
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10297

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


10302
10303
10304
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10302

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


10307
10308
10309
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10307

def self_link_with_id
  @self_link_with_id
end

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



10316
10317
10318
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10316

def service_accounts
  @service_accounts
end

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

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

Returns:



10321
10322
10323
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10321

def shielded_vm_config
  @shielded_vm_config
end

#shielded_vm_integrity_policy ⇒ Google::Apis::ComputeAlpha::ShieldedVmIntegrityPolicy

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

Returns:



10327
10328
10329
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10327

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) 


10332
10333
10334
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10332

def source_machine_image
  @source_machine_image
end

#source_machine_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property sourceMachineImageEncryptionKey

Returns:



10337
10338
10339
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10337

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) 


10343
10344
10345
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10343

def start_restricted
  @start_restricted
end

#status ⇒ String

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. Corresponds to the JSON property status

Returns:

  • (String) 


10351
10352
10353
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10351

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) 


10356
10357
10358
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10356

def status_message
  @status_message
end

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

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

Returns:



10361
10362
10363
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10361

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) 


10368
10369
10370
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10368

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 10375

def update!(**args)
  @allocation_affinity = args[:allocation_affinity] if args.key?(:allocation_affinity)
  @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward)
  @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)
  @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators)
  @hostname = args[:hostname] if args.key?(:hostname)
  @id = args[:id] if args.key?(:id)
  @instance_encryption_key = args[:instance_encryption_key] if args.key?(:instance_encryption_key)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @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)
  @name = args[:name] if args.key?(:name)
  @network_interfaces = args[:network_interfaces] if args.key?(:network_interfaces)
  @preserved_state_size_gb = args[:preserved_state_size_gb] if args.key?(:preserved_state_size_gb)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @scheduling = args[:scheduling] if args.key?(:scheduling)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @service_accounts = args[:service_accounts] if args.key?(:service_accounts)
  @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