Class: Google::Apis::ComputeV1::Instance

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

Overview

Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for $ api_version.instances ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



12027
12028
12029
 
# File 'lib/google/apis/compute_v1/classes.rb', line 12027

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

Instance Attribute Details

#advanced_machine_features ⇒ Google::Apis::ComputeV1::AdvancedMachineFeatures

Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). Corresponds to the JSON property advancedMachineFeatures

Returns:



11776
11777
11778
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11776

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


11783
11784
11785
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11783

def can_ip_forward
  @can_ip_forward
end

#confidential_instance_config ⇒ Google::Apis::ComputeV1::ConfidentialInstanceConfig

A set of Confidential Instance options. Corresponds to the JSON property confidentialInstanceConfig

Returns:



11789
11790
11791
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11789

def confidential_instance_config
  @confidential_instance_config
end

#cpu_platform ⇒ String

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

Returns:

  • (String) 


11794
11795
11796
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11794

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) 


11799
11800
11801
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11799

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) 


11804
11805
11806
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11804

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) 


11811
11812
11813
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11811

def description
  @description
end

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



11817
11818
11819
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11817

def disks
  @disks
end

#display_device ⇒ Google::Apis::ComputeV1::DisplayDevice

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

Returns:



11822
11823
11824
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11822

def display_device
  @display_device
end

#fingerprint ⇒ String

Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


11833
11834
11835
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11833

def fingerprint
  @fingerprint
end

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

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

Returns:



11838
11839
11840
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11838

def guest_accelerators
  @guest_accelerators
end

#hostname ⇒ String

Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [ INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [ INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. Corresponds to the JSON property hostname

Returns:

  • (String) 


11846
11847
11848
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11846

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) 


11852
11853
11854
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11852

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) 


11857
11858
11859
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11857

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) 


11868
11869
11870
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11868

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


11874
11875
11876
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11874

def labels
  @labels
end

#last_start_timestamp ⇒ String

[Output Only] Last start timestamp in RFC3339 text format. Corresponds to the JSON property lastStartTimestamp

Returns:

  • (String) 


11879
11880
11881
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11879

def last_start_timestamp
  @last_start_timestamp
end

#last_stop_timestamp ⇒ String

[Output Only] Last stop timestamp in RFC3339 text format. Corresponds to the JSON property lastStopTimestamp

Returns:

  • (String) 


11884
11885
11886
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11884

def last_stop_timestamp
  @last_stop_timestamp
end

#last_suspended_timestamp ⇒ String

[Output Only] Last suspended timestamp in RFC3339 text format. Corresponds to the JSON property lastSuspendedTimestamp

Returns:

  • (String) 


11889
11890
11891
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11889

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


11906
11907
11908
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11906

def machine_type
  @machine_type
end

#metadata ⇒ Google::Apis::ComputeV1::Metadata

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

Returns:



11911
11912
11913
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11911

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) 


11918
11919
11920
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11918

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) 


11929
11930
11931
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11929

def name
  @name
end

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



11936
11937
11938
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11936

def network_interfaces
  @network_interfaces
end

#post_key_revocation_action_type ⇒ String

PostKeyRevocationActionType of the instance. Corresponds to the JSON property postKeyRevocationActionType

Returns:

  • (String) 


11941
11942
11943
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11941

def post_key_revocation_action_type
  @post_key_revocation_action_type
end

#private_ipv6_google_access ⇒ String

The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Corresponds to the JSON property privateIpv6GoogleAccess

Returns:

  • (String) 


11947
11948
11949
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11947

def private_ipv6_google_access
  @private_ipv6_google_access
end

#reservation_affinity ⇒ Google::Apis::ComputeV1::ReservationAffinity

Specifies the reservations that this instance can consume from. Corresponds to the JSON property reservationAffinity

Returns:



11952
11953
11954
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11952

def reservation_affinity
  @reservation_affinity
end

#resource_policies ⇒ Array<String>

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

Returns:

  • (Array<String>) 


11957
11958
11959
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11957

def resource_policies
  @resource_policies
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


11962
11963
11964
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11962

def satisfies_pzs
  @satisfies_pzs
end

#scheduling ⇒ Google::Apis::ComputeV1::Scheduling

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

Returns:



11968
11969
11970
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11968

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


11973
11974
11975
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11973

def self_link
  @self_link
end

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



11982
11983
11984
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11982

def service_accounts
  @service_accounts
end

#shielded_instance_config ⇒ Google::Apis::ComputeV1::ShieldedInstanceConfig

A set of Shielded Instance options. Corresponds to the JSON property shieldedInstanceConfig

Returns:



11987
11988
11989
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11987

def shielded_instance_config
  @shielded_instance_config
end

#shielded_instance_integrity_policy ⇒ Google::Apis::ComputeV1::ShieldedInstanceIntegrityPolicy

The policy describes the baseline against which Instance boot integrity is measured. Corresponds to the JSON property shieldedInstanceIntegrityPolicy

Returns:



11993
11994
11995
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11993

def shielded_instance_integrity_policy
  @shielded_instance_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) 


11999
12000
12001
 
# File 'lib/google/apis/compute_v1/classes.rb', line 11999

def start_restricted
  @start_restricted
end

#status ⇒ String

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. Corresponds to the JSON property status

Returns:

  • (String) 


12008
12009
12010
 
# File 'lib/google/apis/compute_v1/classes.rb', line 12008

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) 


12013
12014
12015
 
# File 'lib/google/apis/compute_v1/classes.rb', line 12013

def status_message
  @status_message
end

#tags ⇒ Google::Apis::ComputeV1::Tags

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

Returns:



12018
12019
12020
 
# File 'lib/google/apis/compute_v1/classes.rb', line 12018

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) 


12025
12026
12027
 
# File 'lib/google/apis/compute_v1/classes.rb', line 12025

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
 
# File 'lib/google/apis/compute_v1/classes.rb', line 12032

def update!(**args)
  @advanced_machine_features = args[:advanced_machine_features] if args.key?(:advanced_machine_features)
  @can_ip_forward = args[:can_ip_forward] if args.key?(:can_ip_forward)
  @confidential_instance_config = args[:confidential_instance_config] if args.key?(:confidential_instance_config)
  @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)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @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)
  @last_start_timestamp = args[:last_start_timestamp] if args.key?(:last_start_timestamp)
  @last_stop_timestamp = args[:last_stop_timestamp] if args.key?(:last_stop_timestamp)
  @last_suspended_timestamp = args[:last_suspended_timestamp] if args.key?(:last_suspended_timestamp)
  @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)
  @post_key_revocation_action_type = args[:post_key_revocation_action_type] if args.key?(:post_key_revocation_action_type)
  @private_ipv6_google_access = args[:private_ipv6_google_access] if args.key?(:private_ipv6_google_access)
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @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)
  @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