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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Instance

Returns a new instance of Instance.



14043
14044
14045
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14043

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:



13749
13750
13751
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13749

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) 


13756
13757
13758
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13756

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:



13762
13763
13764
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13762

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) 


13767
13768
13769
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13767

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) 


13772
13773
13774
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13772

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) 


13777
13778
13779
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13777

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) 


13784
13785
13786
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13784

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:



13790
13791
13792
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13790

def disks
  @disks
end

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

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

Returns:



13795
13796
13797
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13795

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) 


13806
13807
13808
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13806

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:



13811
13812
13813
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13811

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) 


13819
13820
13821
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13819

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) 


13825
13826
13827
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13825

def id
  @id
end

#instance_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation. Corresponds to the JSON property instanceEncryptionKey

Returns:



13835
13836
13837
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13835

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


13841
13842
13843
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13841

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) 


13846
13847
13848
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13846

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) 


13857
13858
13859
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13857

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


13863
13864
13865
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13863

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) 


13868
13869
13870
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13868

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) 


13873
13874
13875
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13873

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) 


13878
13879
13880
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13878

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) 


13893
13894
13895
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13893

def machine_type
  @machine_type
end

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

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

Returns:



13898
13899
13900
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13898

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) 


13905
13906
13907
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13905

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) 


13916
13917
13918
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13916

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:



13923
13924
13925
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13923

def network_interfaces
  @network_interfaces
end

#network_performance_config ⇒ Google::Apis::ComputeV1::NetworkPerformanceConfig

Corresponds to the JSON property networkPerformanceConfig

Returns:



13928
13929
13930
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13928

def network_performance_config
  @network_performance_config
end

#params ⇒ Google::Apis::ComputeV1::InstanceParams

Additional instance params. Corresponds to the JSON property params

Returns:



13933
13934
13935
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13933

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


13939
13940
13941
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13939

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:



13944
13945
13946
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13944

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


13949
13950
13951
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13949

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeV1::ResourceStatus

Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. Corresponds to the JSON property resourceStatus

Returns:



13956
13957
13958
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13956

def resource_status
  @resource_status
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


13961
13962
13963
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13961

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


13967
13968
13969
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13967

def satisfies_pzs
  @satisfies_pzs
end

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

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

Returns:



13973
13974
13975
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13973

def scheduling
  @scheduling
end

#self_link ⇒ String

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

Returns:

  • (String) 


13978
13979
13980
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13978

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:



13987
13988
13989
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13987

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:



13992
13993
13994
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13992

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:



13998
13999
14000
 
# File 'lib/google/apis/compute_v1/classes.rb', line 13998

def shielded_instance_integrity_policy
  @shielded_instance_integrity_policy
end

#source_machine_image ⇒ String

Source machine image Corresponds to the JSON property sourceMachineImage

Returns:

  • (String) 


14003
14004
14005
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14003

def source_machine_image
  @source_machine_image
end

#source_machine_image_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

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

Returns:



14009
14010
14011
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14009

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) 


14015
14016
14017
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14015

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) 


14024
14025
14026
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14024

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) 


14029
14030
14031
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14029

def status_message
  @status_message
end

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

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

Returns:



14034
14035
14036
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14034

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) 


14041
14042
14043
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14041

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14048

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