Class: Google::Apis::ComputeBeta::Instance
- Inherits:
-
Object
- Object
- Google::Apis::ComputeBeta::Instance
- Defined in:
- generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/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::ComputeBeta::AttachedDisk>
Array of disks associated with this instance.
-
#guest_accelerators ⇒ Array<Google::Apis::ComputeBeta::AcceleratorConfig>
A list of the type and count of accelerator cards attached to the instance.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#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::ComputeBeta::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::ComputeBeta::NetworkInterface>
An array of network configurations for this instance.
-
#scheduling ⇒ Google::Apis::ComputeBeta::Scheduling
Sets the scheduling options for an Instance.
-
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
-
#service_accounts ⇒ Array<Google::Apis::ComputeBeta::ServiceAccount>
A list of service accounts, with their specified scopes, authorized for this instance.
-
#shielded_vm_config ⇒ Google::Apis::ComputeBeta::ShieldedVmConfig
A set of Shielded VM options.
-
#shielded_vm_integrity_policy ⇒ Google::Apis::ComputeBeta::ShieldedVmIntegrityPolicy
The policy describes how boot integrity measurements are evaluated.
-
#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::ComputeBeta::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
7595 7596 7597 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7595 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
7424 7425 7426 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7424 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
7430 7431 7432 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7430 def cpu_platform @cpu_platform end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
7435 7436 7437 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7435 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
7440 7441 7442 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7440 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
7447 7448 7449 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7447 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
7453 7454 7455 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7453 def disks @disks 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
7458 7459 7460 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7458 def guest_accelerators @guest_accelerators end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
7464 7465 7466 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7464 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#instance for instances.
Corresponds to the JSON property kind
7469 7470 7471 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7469 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.
7480 7481 7482 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7480 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
7486 7487 7488 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7486 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
7503 7504 7505 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7503 def machine_type @machine_type end |
#metadata ⇒ Google::Apis::ComputeBeta::Metadata
A metadata key/value entry.
Corresponds to the JSON property metadata
7508 7509 7510 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7508 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
7515 7516 7517 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7515 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
7526 7527 7528 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7526 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
7533 7534 7535 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7533 def network_interfaces @network_interfaces end |
#scheduling ⇒ Google::Apis::ComputeBeta::Scheduling
Sets the scheduling options for an Instance.
Corresponds to the JSON property scheduling
7538 7539 7540 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7538 def scheduling @scheduling end |
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
Corresponds to the JSON property selfLink
7543 7544 7545 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7543 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
7552 7553 7554 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7552 def service_accounts @service_accounts end |
#shielded_vm_config ⇒ Google::Apis::ComputeBeta::ShieldedVmConfig
A set of Shielded VM options.
Corresponds to the JSON property shieldedVmConfig
7557 7558 7559 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7557 def shielded_vm_config @shielded_vm_config end |
#shielded_vm_integrity_policy ⇒ Google::Apis::ComputeBeta::ShieldedVmIntegrityPolicy
The policy describes how boot integrity measurements are evaluated.
Corresponds to the JSON property shieldedVmIntegrityPolicy
7562 7563 7564 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7562 def shielded_vm_integrity_policy @shielded_vm_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
7568 7569 7570 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7568 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
7576 7577 7578 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7576 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
7581 7582 7583 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7581 def @status_message end |
#tags ⇒ Google::Apis::ComputeBeta::Tags
A set of instance tags.
Corresponds to the JSON property tags
7586 7587 7588 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7586 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
7593 7594 7595 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7593 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 |
# File 'generated/google/apis/compute_beta/classes.rb', line 7600 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) @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) @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) @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) @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 |