Class: Google::Apis::ComputeAlpha::Instance
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Instance
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
An Instance resource. (== resource_for beta.instances ==) (== resource_for v1. instances ==)
Instance Attribute Summary collapse
-
#can_ip_forward ⇒ Boolean
(also: #can_ip_forward?)
Allows this instance to send and receive packets with non-matching destination or source IPs.
-
#cpu_platform ⇒ String
[Output Only] The CPU platform used by this instance.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#deletion_protection ⇒ Boolean
(also: #deletion_protection?)
Whether the resource should be protected against deletion.
-
#description ⇒ String
An optional description of this resource.
-
#disks ⇒ Array<Google::Apis::ComputeAlpha::AttachedDisk>
Array of disks associated with this instance.
-
#guest_accelerators ⇒ Array<Google::Apis::ComputeAlpha::AcceleratorConfig>
A list of the type and count of accelerator cards attached to the instance.
-
#host ⇒ String
Full or partial URL of the host resource that the instance should be placed on, in the format: zones/zone/hosts/host.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#instance_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
instanceEncryptionKey
. -
#kind ⇒ String
[Output Only] Type of the resource.
-
#label_fingerprint ⇒ String
A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels to apply to this instance.
-
#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.
-
#metadata ⇒ Google::Apis::ComputeAlpha::Metadata
A metadata key/value entry.
-
#min_cpu_platform ⇒ String
Specifies a minimum CPU platform for the VM instance.
-
#name ⇒ String
The name of the resource, provided by the client when initially creating the resource.
-
#network_interfaces ⇒ Array<Google::Apis::ComputeAlpha::NetworkInterface>
An array of network configurations for this instance.
-
#preserved_state_size_gb ⇒ Fixnum
Total amount of preserved state for SUSPENDED instances.
-
#resource_policies ⇒ Array<String>
Resource policies applied to this instance.
-
#scheduling ⇒ Google::Apis::ComputeAlpha::Scheduling
Sets the scheduling options for an Instance.
-
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
-
#service_accounts ⇒ Array<Google::Apis::ComputeAlpha::ServiceAccount>
A list of service accounts, with their specified scopes, authorized for this instance.
-
#shielded_vm_config ⇒ Google::Apis::ComputeAlpha::ShieldedVmConfig
A set of Shielded VM options.
-
#shielded_vm_integrity_policy ⇒ Google::Apis::ComputeAlpha::ShieldedVmIntegrityPolicy
The policy describes how boot integrity measurements are evaluated.
-
#source_machine_image ⇒ String
Source machine image Corresponds to the JSON property
sourceMachineImage
. -
#start_restricted ⇒ Boolean
(also: #start_restricted?)
[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.
-
#status ⇒ String
[Output Only] The status of the instance.
-
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
-
#tags ⇒ Google::Apis::ComputeAlpha::Tags
A set of instance tags.
-
#zone ⇒ String
[Output Only] URL of the zone where the instance resides.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Instance
constructor
A new instance of Instance.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Instance
Returns a new instance of Instance
9172 9173 9174 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9172 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
8971 8972 8973 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8971 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
8977 8978 8979 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8977 def cpu_platform @cpu_platform end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
8982 8983 8984 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8982 def @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
8987 8988 8989 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8987 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
8994 8995 8996 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8994 def description @description end |
#disks ⇒ Array<Google::Apis::ComputeAlpha::AttachedDisk>
Array of disks associated with this instance. Persistent disks must be created
before you can assign them.
Corresponds to the JSON property disks
9000 9001 9002 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9000 def disks @disks end |
#guest_accelerators ⇒ Array<Google::Apis::ComputeAlpha::AcceleratorConfig>
A list of the type and count of accelerator cards attached to the instance.
Corresponds to the JSON property guestAccelerators
9005 9006 9007 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9005 def guest_accelerators @guest_accelerators end |
#host ⇒ String
Full or partial URL of the host resource that the instance should be placed on,
in the format: zones/zone/hosts/host.
Optional, sole-tenant Host (physical machine) that the instance will be placed
on when it's created. The instance is guaranteed to be placed on the same
machine as other instances with the same sole-tenant host.
The request will be rejected if the sole-tenant host has run out of resources.
Corresponds to the JSON property host
9015 9016 9017 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9015 def host @host end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
9021 9022 9023 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9021 def id @id end |
#instance_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property instanceEncryptionKey
9026 9027 9028 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9026 def instance_encryption_key @instance_encryption_key end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#instance for instances.
Corresponds to the JSON property kind
9031 9032 9033 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9031 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.
9042 9043 9044 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9042 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
9048 9049 9050 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9048 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
9065 9066 9067 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9065 def machine_type @machine_type end |
#metadata ⇒ Google::Apis::ComputeAlpha::Metadata
A metadata key/value entry.
Corresponds to the JSON property metadata
9070 9071 9072 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9070 def @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
9077 9078 9079 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9077 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
9088 9089 9090 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9088 def name @name end |
#network_interfaces ⇒ Array<Google::Apis::ComputeAlpha::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
9095 9096 9097 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9095 def network_interfaces @network_interfaces end |
#preserved_state_size_gb ⇒ Fixnum
Total amount of preserved state for SUSPENDED instances. Read-only in the api.
Corresponds to the JSON property preservedStateSizeGb
9100 9101 9102 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9100 def preserved_state_size_gb @preserved_state_size_gb end |
#resource_policies ⇒ Array<String>
Resource policies applied to this instance.
Corresponds to the JSON property resourcePolicies
9105 9106 9107 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9105 def resource_policies @resource_policies end |
#scheduling ⇒ Google::Apis::ComputeAlpha::Scheduling
Sets the scheduling options for an Instance.
Corresponds to the JSON property scheduling
9110 9111 9112 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9110 def scheduling @scheduling end |
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
Corresponds to the JSON property selfLink
9115 9116 9117 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9115 def self_link @self_link end |
#service_accounts ⇒ Array<Google::Apis::ComputeAlpha::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
9124 9125 9126 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9124 def service_accounts @service_accounts end |
#shielded_vm_config ⇒ Google::Apis::ComputeAlpha::ShieldedVmConfig
A set of Shielded VM options.
Corresponds to the JSON property shieldedVmConfig
9129 9130 9131 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9129 def shielded_vm_config @shielded_vm_config end |
#shielded_vm_integrity_policy ⇒ Google::Apis::ComputeAlpha::ShieldedVmIntegrityPolicy
The policy describes how boot integrity measurements are evaluated.
Corresponds to the JSON property shieldedVmIntegrityPolicy
9134 9135 9136 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9134 def shielded_vm_integrity_policy @shielded_vm_integrity_policy end |
#source_machine_image ⇒ String
Source machine image
Corresponds to the JSON property sourceMachineImage
9139 9140 9141 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9139 def source_machine_image @source_machine_image 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
9145 9146 9147 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9145 def start_restricted @start_restricted end |
#status ⇒ String
[Output Only] The status of the instance. One of the following values:
PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and
TERMINATED.
Corresponds to the JSON property status
9153 9154 9155 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9153 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
9158 9159 9160 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9158 def @status_message end |
#tags ⇒ Google::Apis::ComputeAlpha::Tags
A set of instance tags.
Corresponds to the JSON property tags
9163 9164 9165 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9163 def @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
9170 9171 9172 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9170 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9177 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) @deletion_protection = args[:deletion_protection] if args.key?(:deletion_protection) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @guest_accelerators = args[:guest_accelerators] if args.key?(:guest_accelerators) @host = args[:host] if args.key?(:host) @id = args[:id] if args.key?(:id) @instance_encryption_key = args[:instance_encryption_key] if args.key?(:instance_encryption_key) @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) @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) @preserved_state_size_gb = args[:preserved_state_size_gb] if args.key?(:preserved_state_size_gb) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @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_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) @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 |