compute  v1
Properties | List of all members
Google.Apis.Compute.v1.Data.Instance Class Reference

Represents an Instance resource. More...

Inheritance diagram for Google.Apis.Compute.v1.Data.Instance:
Google::Apis::Requests::IDirectResponseSchema

Properties

virtual System.Nullable< bool > CanIpForward [get, set]
 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. More...
 
virtual string CpuPlatform [get, set]
 [Output Only] The CPU platform used by this instance. More...
 
virtual string CreationTimestamp [get, set]
 [Output Only] Creation timestamp in RFC3339 text format. More...
 
virtual System.Nullable< bool > DeletionProtection [get, set]
 Whether the resource should be protected against deletion. More...
 
virtual string Description [get, set]
 An optional description of this resource. Provide this property when you create the resource. More...
 
virtual System.Collections.Generic.IList< AttachedDiskDisks [get, set]
 Array of disks associated with this instance. Persistent disks must be created before you can assign them. More...
 
virtual DisplayDevice DisplayDevice [get, set]
 Enables display device for the instance. More...
 
virtual System.Collections.Generic.IList< AcceleratorConfigGuestAccelerators [get, set]
 A list of the type and count of accelerator cards attached to the instance. More...
 
virtual string Hostname [get, set]
 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.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. More...
 
virtual System.Nullable< ulong > Id [get, set]
 [Output Only] The unique identifier for the resource. This identifier is defined by the server. More...
 
virtual string Kind [get, set]
 [Output Only] Type of the resource. Always compute::instance for instances. More...
 
virtual string LabelFingerprint [get, set]
 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. More...
 
virtual System.Collections.Generic.IDictionary< string, string > Labels [get, set]
 Labels to apply to this instance. These can be later modified by the setLabels method. More...
 
virtual string MachineType [get, set]
 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 More...
 
virtual Metadata Metadata [get, set]
 The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. More...
 
virtual string MinCpuPlatform [get, set]
 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". More...
 
virtual string Name [get, set]
 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. More...
 
virtual System.Collections.Generic.IList< NetworkInterfaceNetworkInterfaces [get, set]
 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. More...
 
virtual ReservationAffinity ReservationAffinity [get, set]
 Specifies the reservations that this instance can consume from. More...
 
virtual Scheduling Scheduling [get, set]
 Sets the scheduling options for this instance. More...
 
virtual string SelfLink [get, set]
 [Output Only] Server-defined URL for this resource. More...
 
virtual System.Collections.Generic.IList< ServiceAccountServiceAccounts [get, set]
 A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. More...
 
virtual ShieldedInstanceConfig ShieldedInstanceConfig [get, set]
 
virtual ShieldedInstanceIntegrityPolicy ShieldedInstanceIntegrityPolicy [get, set]
 
virtual System.Nullable< bool > StartRestricted [get, set]
 [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. More...
 
virtual string Status [get, set]
 [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED. More...
 
virtual string StatusMessage [get, set]
 [Output Only] An optional, human-readable explanation of the status. More...
 
virtual Tags Tags [get, set]
 Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. More...
 
virtual string Zone [get, set]
 [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. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

Represents an Instance resource.

An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)

Property Documentation

◆ CanIpForward

virtual System.Nullable<bool> Google.Apis.Compute.v1.Data.Instance.CanIpForward
getset

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.

◆ CpuPlatform

virtual string Google.Apis.Compute.v1.Data.Instance.CpuPlatform
getset

[Output Only] The CPU platform used by this instance.

◆ CreationTimestamp

virtual string Google.Apis.Compute.v1.Data.Instance.CreationTimestamp
getset

[Output Only] Creation timestamp in RFC3339 text format.

◆ DeletionProtection

virtual System.Nullable<bool> Google.Apis.Compute.v1.Data.Instance.DeletionProtection
getset

Whether the resource should be protected against deletion.

◆ Description

virtual string Google.Apis.Compute.v1.Data.Instance.Description
getset

An optional description of this resource. Provide this property when you create the resource.

◆ Disks

virtual System.Collections.Generic.IList<AttachedDisk> Google.Apis.Compute.v1.Data.Instance.Disks
getset

Array of disks associated with this instance. Persistent disks must be created before you can assign them.

◆ DisplayDevice

virtual DisplayDevice Google.Apis.Compute.v1.Data.Instance.DisplayDevice
getset

Enables display device for the instance.

◆ ETag

virtual string Google.Apis.Compute.v1.Data.Instance.ETag
getset

The ETag of the item.

◆ GuestAccelerators

virtual System.Collections.Generic.IList<AcceleratorConfig> Google.Apis.Compute.v1.Data.Instance.GuestAccelerators
getset

A list of the type and count of accelerator cards attached to the instance.

◆ Hostname

virtual string Google.Apis.Compute.v1.Data.Instance.Hostname
getset

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.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

◆ Id

virtual System.Nullable<ulong> Google.Apis.Compute.v1.Data.Instance.Id
getset

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

◆ Kind

virtual string Google.Apis.Compute.v1.Data.Instance.Kind
getset

[Output Only] Type of the resource. Always compute::instance for instances.

◆ LabelFingerprint

virtual string Google.Apis.Compute.v1.Data.Instance.LabelFingerprint
getset

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.

◆ Labels

virtual System.Collections.Generic.IDictionary<string,string> Google.Apis.Compute.v1.Data.Instance.Labels
getset

Labels to apply to this instance. These can be later modified by the setLabels method.

◆ MachineType

virtual string Google.Apis.Compute.v1.Data.Instance.MachineType
getset

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.

◆ Metadata

virtual Metadata Google.Apis.Compute.v1.Data.Instance.Metadata
getset

The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

◆ MinCpuPlatform

virtual string Google.Apis.Compute.v1.Data.Instance.MinCpuPlatform
getset

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".

◆ Name

virtual string Google.Apis.Compute.v1.Data.Instance.Name
getset

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.

◆ NetworkInterfaces

virtual System.Collections.Generic.IList<NetworkInterface> Google.Apis.Compute.v1.Data.Instance.NetworkInterfaces
getset

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.

◆ ReservationAffinity

virtual ReservationAffinity Google.Apis.Compute.v1.Data.Instance.ReservationAffinity
getset

Specifies the reservations that this instance can consume from.

◆ Scheduling

virtual Scheduling Google.Apis.Compute.v1.Data.Instance.Scheduling
getset

Sets the scheduling options for this instance.

◆ SelfLink

virtual string Google.Apis.Compute.v1.Data.Instance.SelfLink
getset

[Output Only] Server-defined URL for this resource.

◆ ServiceAccounts

virtual System.Collections.Generic.IList<ServiceAccount> Google.Apis.Compute.v1.Data.Instance.ServiceAccounts
getset

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.

◆ StartRestricted

virtual System.Nullable<bool> Google.Apis.Compute.v1.Data.Instance.StartRestricted
getset

[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

◆ Status

virtual string Google.Apis.Compute.v1.Data.Instance.Status
getset

[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.

◆ StatusMessage

virtual string Google.Apis.Compute.v1.Data.Instance.StatusMessage
getset

[Output Only] An optional, human-readable explanation of the status.

◆ Tags

virtual Tags Google.Apis.Compute.v1.Data.Instance.Tags
getset

Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field.

◆ Zone

virtual string Google.Apis.Compute.v1.Data.Instance.Zone
getset

[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.


The documentation for this class was generated from the following file: