Represents an Instance.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.IInstance);Constructs a new Instance.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstance
Properties to set |
Properties
_advancedMachineFeatures
public _advancedMachineFeatures?: "advancedMachineFeatures";Instance _advancedMachineFeatures.
_canIpForward
public _canIpForward?: "canIpForward";Instance _canIpForward.
_confidentialInstanceConfig
public _confidentialInstanceConfig?: "confidentialInstanceConfig";Instance _confidentialInstanceConfig.
_cpuPlatform
public _cpuPlatform?: "cpuPlatform";Instance _cpuPlatform.
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";Instance _creationTimestamp.
_deletionProtection
public _deletionProtection?: "deletionProtection";Instance _deletionProtection.
_description
public _description?: "description";Instance _description.
_displayDevice
public _displayDevice?: "displayDevice";Instance _displayDevice.
_fingerprint
public _fingerprint?: "fingerprint";Instance _fingerprint.
_hostname
public _hostname?: "hostname";Instance _hostname.
_id
public _id?: "id";Instance _id.
_instanceEncryptionKey
public _instanceEncryptionKey?: "instanceEncryptionKey";Instance _instanceEncryptionKey.
_keyRevocationActionType
public _keyRevocationActionType?: "keyRevocationActionType";Instance _keyRevocationActionType.
_kind
public _kind?: "kind";Instance _kind.
_labelFingerprint
public _labelFingerprint?: "labelFingerprint";Instance _labelFingerprint.
_lastStartTimestamp
public _lastStartTimestamp?: "lastStartTimestamp";Instance _lastStartTimestamp.
_lastStopTimestamp
public _lastStopTimestamp?: "lastStopTimestamp";Instance _lastStopTimestamp.
_lastSuspendedTimestamp
public _lastSuspendedTimestamp?: "lastSuspendedTimestamp";Instance _lastSuspendedTimestamp.
_machineType
public _machineType?: "machineType";Instance _machineType.
_metadata
public _metadata?: "metadata";Instance _metadata.
_minCpuPlatform
public _minCpuPlatform?: "minCpuPlatform";Instance _minCpuPlatform.
_name
public _name?: "name";Instance _name.
_networkPerformanceConfig
public _networkPerformanceConfig?: "networkPerformanceConfig";Instance _networkPerformanceConfig.
_params
public _params?: "params";Instance _params.
_privateIpv6GoogleAccess
public _privateIpv6GoogleAccess?: "privateIpv6GoogleAccess";Instance _privateIpv6GoogleAccess.
_reservationAffinity
public _reservationAffinity?: "reservationAffinity";Instance _reservationAffinity.
_resourceStatus
public _resourceStatus?: "resourceStatus";Instance _resourceStatus.
_satisfiesPzi
public _satisfiesPzi?: "satisfiesPzi";Instance _satisfiesPzi.
_satisfiesPzs
public _satisfiesPzs?: "satisfiesPzs";Instance _satisfiesPzs.
_scheduling
public _scheduling?: "scheduling";Instance _scheduling.
_selfLink
public _selfLink?: "selfLink";Instance _selfLink.
_shieldedInstanceConfig
public _shieldedInstanceConfig?: "shieldedInstanceConfig";Instance _shieldedInstanceConfig.
_shieldedInstanceIntegrityPolicy
public _shieldedInstanceIntegrityPolicy?: "shieldedInstanceIntegrityPolicy";Instance _shieldedInstanceIntegrityPolicy.
_sourceMachineImage
public _sourceMachineImage?: "sourceMachineImage";Instance _sourceMachineImage.
_sourceMachineImageEncryptionKey
public _sourceMachineImageEncryptionKey?: "sourceMachineImageEncryptionKey";Instance _sourceMachineImageEncryptionKey.
_startRestricted
public _startRestricted?: "startRestricted";Instance _startRestricted.
_status
public _status?: "status";Instance _status.
_statusMessage
public _statusMessage?: "statusMessage";Instance _statusMessage.
_tags
public _tags?: "tags";Instance _tags.
_zone
public _zone?: "zone";Instance _zone.
advancedMachineFeatures
public advancedMachineFeatures?: (google.cloud.compute.v1.IAdvancedMachineFeatures|null);Instance advancedMachineFeatures.
canIpForward
public canIpForward?: (boolean|null);Instance canIpForward.
confidentialInstanceConfig
public confidentialInstanceConfig?: (google.cloud.compute.v1.IConfidentialInstanceConfig|null);Instance confidentialInstanceConfig.
cpuPlatform
public cpuPlatform?: (string|null);Instance cpuPlatform.
creationTimestamp
public creationTimestamp?: (string|null);Instance creationTimestamp.
deletionProtection
public deletionProtection?: (boolean|null);Instance deletionProtection.
description
public description?: (string|null);Instance description.
disks
public disks: google.cloud.compute.v1.IAttachedDisk[];Instance disks.
displayDevice
public displayDevice?: (google.cloud.compute.v1.IDisplayDevice|null);Instance displayDevice.
fingerprint
public fingerprint?: (string|null);Instance fingerprint.
guestAccelerators
public guestAccelerators: google.cloud.compute.v1.IAcceleratorConfig[];Instance guestAccelerators.
hostname
public hostname?: (string|null);Instance hostname.
id
public id?: (number|Long|string|null);Instance id.
instanceEncryptionKey
public instanceEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);Instance instanceEncryptionKey.
keyRevocationActionType
public keyRevocationActionType?: (string|null);Instance keyRevocationActionType.
kind
public kind?: (string|null);Instance kind.
labelFingerprint
public labelFingerprint?: (string|null);Instance labelFingerprint.
labels
public labels: { [k: string]: string };Instance labels.
lastStartTimestamp
public lastStartTimestamp?: (string|null);Instance lastStartTimestamp.
lastStopTimestamp
public lastStopTimestamp?: (string|null);Instance lastStopTimestamp.
lastSuspendedTimestamp
public lastSuspendedTimestamp?: (string|null);Instance lastSuspendedTimestamp.
machineType
public machineType?: (string|null);Instance machineType.
metadata
public metadata?: (google.cloud.compute.v1.IMetadata|null);Instance metadata.
minCpuPlatform
public minCpuPlatform?: (string|null);Instance minCpuPlatform.
name
public name?: (string|null);Instance name.
networkInterfaces
public networkInterfaces: google.cloud.compute.v1.INetworkInterface[];Instance networkInterfaces.
networkPerformanceConfig
public networkPerformanceConfig?: (google.cloud.compute.v1.INetworkPerformanceConfig|null);Instance networkPerformanceConfig.
params
public params?: (google.cloud.compute.v1.IInstanceParams|null);Instance params.
privateIpv6GoogleAccess
public privateIpv6GoogleAccess?: (string|null);Instance privateIpv6GoogleAccess.
reservationAffinity
public reservationAffinity?: (google.cloud.compute.v1.IReservationAffinity|null);Instance reservationAffinity.
resourcePolicies
public resourcePolicies: string[];Instance resourcePolicies.
resourceStatus
public resourceStatus?: (google.cloud.compute.v1.IResourceStatus|null);Instance resourceStatus.
satisfiesPzi
public satisfiesPzi?: (boolean|null);Instance satisfiesPzi.
satisfiesPzs
public satisfiesPzs?: (boolean|null);Instance satisfiesPzs.
scheduling
public scheduling?: (google.cloud.compute.v1.IScheduling|null);Instance scheduling.
selfLink
public selfLink?: (string|null);Instance selfLink.
serviceAccounts
public serviceAccounts: google.cloud.compute.v1.IServiceAccount[];Instance serviceAccounts.
shieldedInstanceConfig
public shieldedInstanceConfig?: (google.cloud.compute.v1.IShieldedInstanceConfig|null);Instance shieldedInstanceConfig.
shieldedInstanceIntegrityPolicy
public shieldedInstanceIntegrityPolicy?: (google.cloud.compute.v1.IShieldedInstanceIntegrityPolicy|null);Instance shieldedInstanceIntegrityPolicy.
sourceMachineImage
public sourceMachineImage?: (string|null);Instance sourceMachineImage.
sourceMachineImageEncryptionKey
public sourceMachineImageEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);Instance sourceMachineImageEncryptionKey.
startRestricted
public startRestricted?: (boolean|null);Instance startRestricted.
status
public status?: (string|null);Instance status.
statusMessage
public statusMessage?: (string|null);Instance statusMessage.
tags
public tags?: (google.cloud.compute.v1.ITags|null);Instance tags.
zone
public zone?: (string|null);Instance zone.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.IInstance): google.cloud.compute.v1.Instance;Creates a new Instance instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IInstance
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Instance | Instance instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.Instance;Decodes an Instance message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Instance | Instance |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.Instance;Decodes an Instance message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Instance | Instance |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Instance message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstance
Instance message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.compute.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Instance message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IInstance
Instance message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.Instance;Creates an Instance message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Instance | Instance |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Instance
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Instance to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.Instance, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Instance message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Instance
Instance |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an Instance message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|