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



7272
7273
7274
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7272

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) 


7112
7113
7114
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7112

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) 


7118
7119
7120
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7118

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) 


7123
7124
7125
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7123

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) 


7128
7129
7130
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7128

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) 


7135
7136
7137
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7135

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:



7141
7142
7143
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7141

def disks
  @disks
end

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

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

Returns:



7146
7147
7148
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7146

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


7152
7153
7154
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7152

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) 


7157
7158
7159
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7157

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata. 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) 


7168
7169
7170
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7168

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


7174
7175
7176
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7174

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) 


7191
7192
7193
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7191

def machine_type
  @machine_type
end

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

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

Returns:



7196
7197
7198
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7196

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) 


7203
7204
7205
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7203

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


7213
7214
7215
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7213

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:



7220
7221
7222
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7220

def network_interfaces
  @network_interfaces
end

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

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

Returns:



7225
7226
7227
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7225

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


7230
7231
7232
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7230

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:



7239
7240
7241
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7239

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


7245
7246
7247
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7245

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) 


7253
7254
7255
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7253

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) 


7258
7259
7260
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7258

def status_message
  @status_message
end

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

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

Returns:



7263
7264
7265
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7263

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) 


7270
7271
7272
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7270

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
 
# File 'generated/google/apis/compute_beta/classes.rb', line 7277

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