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.
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.
-
#description ⇒ String
An optional description of this resource.
-
#disks ⇒ Array<Google::Apis::ComputeBeta::AttachedDisk>
Array of disks associated with this instance.
-
#id ⇒ String
[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 metadata'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.
-
#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 configurations for this interface.
-
#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.
-
#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.
3818 3819 3820 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3818 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
3686 3687 3688 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3686 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
3692 3693 3694 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3692 def cpu_platform @cpu_platform end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
3697 3698 3699 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3697 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
3703 3704 3705 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3703 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
3709 3710 3711 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3709 def disks @disks end |
#id ⇒ String
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
3715 3716 3717 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3715 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#instance for instances.
Corresponds to the JSON property kind
3720 3721 3722 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3720 def kind @kind end |
#label_fingerprint ⇒ String
A fingerprint for this request, which is essentially a hash of the metadata's
contents and used for optimistic locking. The fingerprint is initially
generated by Compute Engine and changes after every request to modify or
update metadata. You must always provide an up-to-date fingerprint hash in
order to update or change metadata.
To see the latest fingerprint, make get() request to the instance.
Corresponds to the JSON property labelFingerprint
3730 3731 3732 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3730 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. Each label key/value pair must comply with RFC1035. Label values may
be empty.
Corresponds to the JSON property labels
3737 3738 3739 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3737 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
3754 3755 3756 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3754 def machine_type @machine_type end |
#metadata ⇒ Google::Apis::ComputeBeta::Metadata
A metadata key/value entry.
Corresponds to the JSON property metadata
3759 3760 3761 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3759 def @metadata 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? 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
3769 3770 3771 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3769 def name @name end |
#network_interfaces ⇒ Array<Google::Apis::ComputeBeta::NetworkInterface>
An array of configurations for this interface. This specifies how this
interface is configured to interact with other network services, such as
connecting to the internet. Only one interface is supported per instance.
Corresponds to the JSON property networkInterfaces
3776 3777 3778 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3776 def network_interfaces @network_interfaces end |
#scheduling ⇒ Google::Apis::ComputeBeta::Scheduling
Sets the scheduling options for an Instance.
Corresponds to the JSON property scheduling
3781 3782 3783 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3781 def scheduling @scheduling end |
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
Corresponds to the JSON property selfLink
3786 3787 3788 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3786 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. 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
3794 3795 3796 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3794 def service_accounts @service_accounts end |
#status ⇒ String
[Output Only] The status of the instance. One of the following values:
PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDED, SUSPENDING, and
TERMINATED.
Corresponds to the JSON property status
3801 3802 3803 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3801 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
3806 3807 3808 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3806 def @status_message end |
#tags ⇒ Google::Apis::ComputeBeta::Tags
A set of instance tags.
Corresponds to the JSON property tags
3811 3812 3813 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3811 def @tags end |
#zone ⇒ String
[Output Only] URL of the zone where the instance resides.
Corresponds to the JSON property zone
3816 3817 3818 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3816 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 |
# File 'generated/google/apis/compute_beta/classes.rb', line 3823 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) @description = args[:description] if args.key?(:description) @disks = args[:disks] if args.key?(:disks) @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) @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) @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 |