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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/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



8555
8556
8557
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8555

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

Instance Attribute Details

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


8356
8357
8358
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8356

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) 


8362
8363
8364
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8362

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) 


8367
8368
8369
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8367

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) 


8372
8373
8374
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8372

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) 


8379
8380
8381
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8379

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:



8385
8386
8387
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8385

def disks
  @disks
end

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

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

Returns:



8390
8391
8392
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8390

def display_device
  @display_device
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:



8395
8396
8397
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8395

def guest_accelerators
  @guest_accelerators
end

#hostname ⇒ String

Corresponds to the JSON property hostname

Returns:

  • (String) 


8400
8401
8402
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8400

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) 


8406
8407
8408
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8406

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


8411
8412
8413
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8411

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) 


8422
8423
8424
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8422

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


8428
8429
8430
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8428

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) 


8445
8446
8447
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8445

def machine_type
  @machine_type
end

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

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

Returns:



8450
8451
8452
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8450

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) 


8457
8458
8459
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8457

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) 


8468
8469
8470
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8468

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:



8475
8476
8477
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8475

def network_interfaces
  @network_interfaces
end

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

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

Returns:



8481
8482
8483
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8481

def reservation_affinity
  @reservation_affinity
end

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

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

Returns:



8486
8487
8488
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8486

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


8491
8492
8493
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8491

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:



8500
8501
8502
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8500

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:



8505
8506
8507
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8505

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:



8511
8512
8513
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8511

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:



8516
8517
8518
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8516

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:



8522
8523
8524
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8522

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


8528
8529
8530
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8528

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) 


8536
8537
8538
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8536

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) 


8541
8542
8543
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8541

def status_message
  @status_message
end

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

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

Returns:



8546
8547
8548
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8546

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) 


8553
8554
8555
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8553

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
 
# File 'generated/google/apis/compute_beta/classes.rb', line 8560

def update!(**args)
  @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)
  @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)
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
  @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)
  @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