Class: Google::Apis::ComputeV1::Instance
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Instance
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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::ComputeV1::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.
-
#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::ComputeV1::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::ComputeV1::NetworkInterface>
An array of configurations for this interface.
-
#scheduling ⇒ Google::Apis::ComputeV1::Scheduling
Sets the scheduling options for an Instance.
-
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
-
#service_accounts ⇒ Array<Google::Apis::ComputeV1::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::ComputeV1::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.
3299 3300 3301 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3299 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
3184 3185 3186 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3184 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
3190 3191 3192 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3190 def cpu_platform @cpu_platform end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
3195 3196 3197 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3195 def end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
3201 3202 3203 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3201 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
3207 3208 3209 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3207 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
3213 3214 3215 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3213 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#instance for instances.
Corresponds to the JSON property kind
3218 3219 3220 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3218 def kind @kind 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
3235 3236 3237 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3235 def machine_type @machine_type end |
#metadata ⇒ Google::Apis::ComputeV1::Metadata
A metadata key/value entry.
Corresponds to the JSON property metadata
3240 3241 3242 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3240 def 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
3250 3251 3252 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3250 def name @name end |
#network_interfaces ⇒ Array<Google::Apis::ComputeV1::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
3257 3258 3259 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3257 def network_interfaces @network_interfaces end |
#scheduling ⇒ Google::Apis::ComputeV1::Scheduling
Sets the scheduling options for an Instance.
Corresponds to the JSON property scheduling
3262 3263 3264 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3262 def scheduling @scheduling end |
#self_link ⇒ String
[Output Only] Server-defined URL for this resource.
Corresponds to the JSON property selfLink
3267 3268 3269 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3267 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. 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
3275 3276 3277 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3275 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
3282 3283 3284 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3282 def status @status end |
#status_message ⇒ String
[Output Only] An optional, human-readable explanation of the status.
Corresponds to the JSON property statusMessage
3287 3288 3289 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3287 def end |
#tags ⇒ Google::Apis::ComputeV1::Tags
A set of instance tags.
Corresponds to the JSON property tags
3292 3293 3294 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3292 def end |
#zone ⇒ String
[Output Only] URL of the zone where the instance resides.
Corresponds to the JSON property zone
3297 3298 3299 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3297 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 |
# File 'generated/google/apis/compute_v1/classes.rb', line 3304 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) = 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) @machine_type = args[:machine_type] if args.key?(:machine_type) = 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) = args[:status_message] if args.key?(:status_message) = args[:tags] if args.key?(:tags) @zone = args[:zone] if args.key?(:zone) end |