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.

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



5100
5101
5102
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5100

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) 


4962
4963
4964
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4962

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) 


4968
4969
4970
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4968

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) 


4973
4974
4975
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4973

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


4979
4980
4981
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4979

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:



4985
4986
4987
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4985

def disks
  @disks
end

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

Corresponds to the JSON property guestAccelerators

Returns:



4990
4991
4992
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4990

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) 


4996
4997
4998
 
# File 'generated/google/apis/compute_beta/classes.rb', line 4996

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) 


5001
5002
5003
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5001

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) 


5012
5013
5014
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5012

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


5018
5019
5020
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5018

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) 


5035
5036
5037
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5035

def machine_type
  @machine_type
end

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

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

Returns:



5040
5041
5042
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5040

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


5050
5051
5052
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5050

def name
  @name
end

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

An array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Only one interface is supported per instance. Corresponds to the JSON property networkInterfaces

Returns:



5057
5058
5059
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5057

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:



5062
5063
5064
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5062

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


5067
5068
5069
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5067

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:



5076
5077
5078
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5076

def service_accounts
  @service_accounts
end

#status ⇒ String

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

Returns:

  • (String) 


5083
5084
5085
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5083

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) 


5088
5089
5090
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5088

def status_message
  @status_message
end

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

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

Returns:



5093
5094
5095
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5093

def tags
  @tags
end

#zone ⇒ String

[Output Only] URL of the zone where the instance resides. Corresponds to the JSON property zone

Returns:

  • (String) 


5098
5099
5100
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5098

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
 
# File 'generated/google/apis/compute_beta/classes.rb', line 5105

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