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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



12984
12985
12986
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12984

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

Instance Attribute Details

#advanced_machine_features ⇒ Google::Apis::ComputeBeta::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:



12690
12691
12692
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12690

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) 


12697
12698
12699
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12697

def can_ip_forward
  @can_ip_forward
end

#confidential_instance_config ⇒ Google::Apis::ComputeBeta::ConfidentialInstanceConfig

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

Returns:



12703
12704
12705
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12703

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) 


12708
12709
12710
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12708

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) 


12713
12714
12715
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12713

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) 


12718
12719
12720
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12718

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) 


12725
12726
12727
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12725

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:



12731
12732
12733
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12731

def disks
  @disks
end

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

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

Returns:



12736
12737
12738
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12736

def display_device
  @display_device
end

#erase_windows_vss_signature ⇒ Boolean Also known as: erase_windows_vss_signature?

Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. Corresponds to the JSON property eraseWindowsVssSignature

Returns:

  • (Boolean) 


12742
12743
12744
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12742

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


12754
12755
12756
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12754

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



12759
12760
12761
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12759

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) 


12767
12768
12769
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12767

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) 


12773
12774
12775
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12773

def id
  @id
end

#key_revocation_action_type ⇒ String

KeyRevocationActionType of the instance. Supported options are "STOP" and " NONE". The default value is "NONE" if it is not specified. Corresponds to the JSON property keyRevocationActionType

Returns:

  • (String) 


12779
12780
12781
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12779

def key_revocation_action_type
  @key_revocation_action_type
end

#kind ⇒ String

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

Returns:

  • (String) 


12784
12785
12786
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12784

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) 


12795
12796
12797
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12795

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


12801
12802
12803
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12801

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) 


12806
12807
12808
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12806

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) 


12811
12812
12813
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12811

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) 


12816
12817
12818
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12816

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) 


12831
12832
12833
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12831

def machine_type
  @machine_type
end

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

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

Returns:



12836
12837
12838
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12836

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) 


12843
12844
12845
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12843

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) 


12854
12855
12856
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12854

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:



12861
12862
12863
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12861

def network_interfaces
  @network_interfaces
end

#network_performance_config ⇒ Google::Apis::ComputeBeta::NetworkPerformanceConfig

Corresponds to the JSON property networkPerformanceConfig

Returns:



12866
12867
12868
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12866

def network_performance_config
  @network_performance_config
end

#params ⇒ Google::Apis::ComputeBeta::InstanceParams

Additional instance params. Corresponds to the JSON property params

Returns:



12871
12872
12873
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12871

def params
  @params
end

#post_key_revocation_action_type ⇒ String

PostKeyRevocationActionType of the instance. Corresponds to the JSON property postKeyRevocationActionType

Returns:

  • (String) 


12876
12877
12878
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12876

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) 


12882
12883
12884
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12882

def private_ipv6_google_access
  @private_ipv6_google_access
end

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

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

Returns:



12887
12888
12889
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12887

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


12892
12893
12894
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12892

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) 


12897
12898
12899
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12897

def satisfies_pzs
  @satisfies_pzs
end

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

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

Returns:



12903
12904
12905
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12903

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


12908
12909
12910
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12908

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:



12917
12918
12919
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12917

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:



12922
12923
12924
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12922

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:



12928
12929
12930
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12928

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:



12933
12934
12935
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12933

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:



12939
12940
12941
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12939

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) 


12944
12945
12946
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12944

def source_machine_image
  @source_machine_image
end

#source_machine_image_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Source machine image encryption key when creating an instance from a machine image. Corresponds to the JSON property sourceMachineImageEncryptionKey

Returns:



12950
12951
12952
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12950

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


12956
12957
12958
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12956

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) 


12965
12966
12967
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12965

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) 


12970
12971
12972
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12970

def status_message
  @status_message
end

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

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

Returns:



12975
12976
12977
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12975

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) 


12982
12983
12984
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12982

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
 
# File 'lib/google/apis/compute_beta/classes.rb', line 12989

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)
  @erase_windows_vss_signature = args[:erase_windows_vss_signature] if args.key?(:erase_windows_vss_signature)
  @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)
  @key_revocation_action_type = args[:key_revocation_action_type] if args.key?(:key_revocation_action_type)
  @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)
  @network_performance_config = args[:network_performance_config] if args.key?(:network_performance_config)
  @params = args[:params] if args.key?(:params)
  @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)
  @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)
  @source_machine_image_encryption_key = args[:source_machine_image_encryption_key] if args.key?(:source_machine_image_encryption_key)
  @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