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



9188
9189
9190
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9188

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) 


8987
8988
8989
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8987

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) 


8993
8994
8995
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8993

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) 


8998
8999
9000
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8998

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) 


9003
9004
9005
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9003

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) 


9010
9011
9012
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9010

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:



9016
9017
9018
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9016

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



9021
9022
9023
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9021

def guest_accelerators
  @guest_accelerators
end

#host ⇒ String

Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host. Optional, sole-tenant Host (physical machine) that the instance will be placed on when it's created. The instance is guaranteed to be placed on the same machine as other instances with the same sole-tenant host. The request will be rejected if the sole-tenant host has run out of resources. Corresponds to the JSON property host

Returns:

  • (String) 


9031
9032
9033
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9031

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


9037
9038
9039
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9037

def id
  @id
end

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

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

Returns:



9042
9043
9044
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9042

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) 


9047
9048
9049
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9047

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) 


9058
9059
9060
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9058

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


9064
9065
9066
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9064

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) 


9081
9082
9083
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9081

def machine_type
  @machine_type
end

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

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

Returns:



9086
9087
9088
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9086

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) 


9093
9094
9095
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9093

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) 


9104
9105
9106
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9104

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:



9111
9112
9113
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9111

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) 


9116
9117
9118
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9116

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


9121
9122
9123
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9121

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:



9126
9127
9128
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9126

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


9131
9132
9133
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9131

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



9140
9141
9142
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9140

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:



9145
9146
9147
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9145

def shielded_vm_config
  @shielded_vm_config
end

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

The policy describes how boot integrity measurements are evaluated. Corresponds to the JSON property shieldedVmIntegrityPolicy

Returns:



9150
9151
9152
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9150

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) 


9155
9156
9157
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9155

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


9161
9162
9163
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9161

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) 


9169
9170
9171
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9169

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) 


9174
9175
9176
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9174

def status_message
  @status_message
end

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

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

Returns:



9179
9180
9181
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9179

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) 


9186
9187
9188
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9186

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 9193

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