class Google::Apis::ComputeBeta::Instance
Represents an Instance
resource. An instance is a virtual machine that is hosted on Google
Cloud Platform. For more information, read Virtual Machine Instances.
Attributes
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` @return [Google::Apis::ComputeBeta::AdvancedMachineFeatures]
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` @return [Boolean]
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` @return [Boolean]
A set of Confidential Instance
options. Corresponds to the JSON property `confidentialInstanceConfig` @return [Google::Apis::ComputeBeta::ConfidentialInstanceConfig]
- Output Only
-
The CPU platform used by this instance.
Corresponds to the JSON property `cpuPlatform` @return [String]
- Output Only
-
Creation timestamp in RFC3339 text format.
Corresponds to the JSON property `creationTimestamp` @return [String]
Whether the resource should be protected against deletion. Corresponds to the JSON property `deletionProtection` @return [Boolean]
Whether the resource should be protected against deletion. Corresponds to the JSON property `deletionProtection` @return [Boolean]
An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property `description` @return [String]
Array of disks associated with this instance. Persistent disks must be created before you can assign them. Corresponds to the JSON property `disks` @return [Array<Google::Apis::ComputeBeta::AttachedDisk>]
A set of Display Device options Corresponds to the JSON property `displayDevice` @return [Google::Apis::ComputeBeta::DisplayDevice]
Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. Corresponds to the JSON property `eraseWindowsVssSignature` @return [Boolean]
Specifies whether the disks restored from source snapshots or source machine image should erase Windows specific VSS signature. Corresponds to the JSON property `eraseWindowsVssSignature` @return [Boolean]
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. @return [String]
A list of the type and count of accelerator cards attached to the instance. Corresponds to the JSON property `guestAccelerators` @return [Array<Google::Apis::ComputeBeta::AcceleratorConfig>]
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..internal when using the global DNS, and [ INSTANCE_NAME]..c..internal when using zonal DNS. Corresponds to the JSON property `hostname` @return [String]
- Output Only
-
The unique identifier for the resource. This identifier is
defined by the server. Corresponds to the JSON property `id` @return [Fixnum]
- Output Only
-
Type of the resource. Always compute#instance for instances.
Corresponds to the JSON property `kind` @return [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. @return [String]
Labels to apply to this instance. These can be later modified by the setLabels method. Corresponds to the JSON property `labels` @return [Hash<String,String>]
- Output Only
-
Last start timestamp in RFC3339 text format.
Corresponds to the JSON property `lastStartTimestamp` @return [String]
- Output Only
-
Last stop timestamp in RFC3339 text format.
Corresponds to the JSON property `lastStopTimestamp` @return [String]
- Output Only
-
Last suspended timestamp in RFC3339 text format.
Corresponds to the JSON property `lastSuspendedTimestamp` @return [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` @return [String]
A metadata key/value entry. Corresponds to the JSON property `metadata` @return [Google::Apis::ComputeBeta::Metadata]
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` @return [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])?` 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` @return [String]
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` @return [Array<Google::Apis::ComputeBeta::NetworkInterface>]
Corresponds to the JSON property `networkPerformanceConfig` @return [Google::Apis::ComputeBeta::NetworkPerformanceConfig]
PostKeyRevocationActionType of the instance. Corresponds to the JSON property `postKeyRevocationActionType` @return [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` @return [String]
Specifies the reservations that this instance can consume from. Corresponds to the JSON property `reservationAffinity` @return [Google::Apis::ComputeBeta::ReservationAffinity]
Resource policies applied to this instance. Corresponds to the JSON property `resourcePolicies` @return [Array<String>]
- Output Only
-
Reserved for future use.
Corresponds to the JSON property `satisfiesPzs` @return [Boolean]
- Output Only
-
Reserved for future use.
Corresponds to the JSON property `satisfiesPzs` @return [Boolean]
Sets the scheduling options for an Instance
. NextID: 21 Corresponds to the JSON property `scheduling` @return [Google::Apis::ComputeBeta::Scheduling]
- Output Only
-
Server-defined URL for this resource.
Corresponds to the JSON property `selfLink` @return [String]
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` @return [Array<Google::Apis::ComputeBeta::ServiceAccount>]
A set of Shielded Instance
options. Corresponds to the JSON property `shieldedInstanceConfig` @return [Google::Apis::ComputeBeta::ShieldedInstanceConfig]
The policy describes the baseline against which Instance
boot integrity is measured. Corresponds to the JSON property `shieldedInstanceIntegrityPolicy` @return [Google::Apis::ComputeBeta::ShieldedInstanceIntegrityPolicy]
A set of Shielded VM options. Corresponds to the JSON property `shieldedVmConfig` @return [Google::Apis::ComputeBeta::ShieldedVmConfig]
The policy describes the baseline against which VM instance boot integrity is measured. Corresponds to the JSON property `shieldedVmIntegrityPolicy` @return [Google::Apis::ComputeBeta::ShieldedVmIntegrityPolicy]
Source machine image Corresponds to the JSON property `sourceMachineImage` @return [String]
Source machine image encryption key when creating an instance from a machine image. Corresponds to the JSON property `sourceMachineImageEncryptionKey` @return [Google::Apis::ComputeBeta::CustomerEncryptionKey]
- Output Only
-
Whether a VM has been restricted for start because Compute
Engine has detected suspicious activity. Corresponds to the JSON property `startRestricted` @return [Boolean]
- Output Only
-
Whether a VM has been restricted for start because Compute
Engine has detected suspicious activity. Corresponds to the JSON property `startRestricted` @return [Boolean]
- 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` @return [String]
- Output Only
-
An optional, human-readable explanation of the status.
Corresponds to the JSON property `statusMessage` @return [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` @return [String]
Public Class Methods
# File lib/google/apis/compute_beta/classes.rb, line 12665 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/compute_beta/classes.rb, line 12670 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) @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) @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