Instance

google.cloud.compute.v1. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IInstance <optional>

Properties to set

Implements:
  • IInstance

Members

_advancedMachineFeatures

Instance _advancedMachineFeatures.

_canIpForward

Instance _canIpForward.

_confidentialInstanceConfig

Instance _confidentialInstanceConfig.

_cpuPlatform

Instance _cpuPlatform.

_creationTimestamp

Instance _creationTimestamp.

_deletionProtection

Instance _deletionProtection.

_description

Instance _description.

_displayDevice

Instance _displayDevice.

_fingerprint

Instance _fingerprint.

_hostname

Instance _hostname.

_id

Instance _id.

_keyRevocationActionType

Instance _keyRevocationActionType.

_kind

Instance _kind.

_labelFingerprint

Instance _labelFingerprint.

_lastStartTimestamp

Instance _lastStartTimestamp.

_lastStopTimestamp

Instance _lastStopTimestamp.

_lastSuspendedTimestamp

Instance _lastSuspendedTimestamp.

_machineType

Instance _machineType.

_metadata

Instance _metadata.

_minCpuPlatform

Instance _minCpuPlatform.

_name

Instance _name.

_networkPerformanceConfig

Instance _networkPerformanceConfig.

_params

Instance _params.

_privateIpv6GoogleAccess

Instance _privateIpv6GoogleAccess.

_reservationAffinity

Instance _reservationAffinity.

_resourceStatus

Instance _resourceStatus.

_satisfiesPzs

Instance _satisfiesPzs.

_scheduling

Instance _scheduling.

Instance _selfLink.

_shieldedInstanceConfig

Instance _shieldedInstanceConfig.

_shieldedInstanceIntegrityPolicy

Instance _shieldedInstanceIntegrityPolicy.

_sourceMachineImage

Instance _sourceMachineImage.

_sourceMachineImageEncryptionKey

Instance _sourceMachineImageEncryptionKey.

_startRestricted

Instance _startRestricted.

_status

Instance _status.

_statusMessage

Instance _statusMessage.

_tags

Instance _tags.

_zone

Instance _zone.

advancedMachineFeatures

Instance advancedMachineFeatures.

canIpForward

Instance canIpForward.

confidentialInstanceConfig

Instance confidentialInstanceConfig.

cpuPlatform

Instance cpuPlatform.

creationTimestamp

Instance creationTimestamp.

deletionProtection

Instance deletionProtection.

description

Instance description.

disks

Instance disks.

displayDevice

Instance displayDevice.

fingerprint

Instance fingerprint.

guestAccelerators

Instance guestAccelerators.

hostname

Instance hostname.

id

Instance id.

keyRevocationActionType

Instance keyRevocationActionType.

kind

Instance kind.

labelFingerprint

Instance labelFingerprint.

labels

Instance labels.

lastStartTimestamp

Instance lastStartTimestamp.

lastStopTimestamp

Instance lastStopTimestamp.

lastSuspendedTimestamp

Instance lastSuspendedTimestamp.

machineType

Instance machineType.

metadata

Instance metadata.

minCpuPlatform

Instance minCpuPlatform.

name

Instance name.

networkInterfaces

Instance networkInterfaces.

networkPerformanceConfig

Instance networkPerformanceConfig.

params

Instance params.

privateIpv6GoogleAccess

Instance privateIpv6GoogleAccess.

reservationAffinity

Instance reservationAffinity.

resourcePolicies

Instance resourcePolicies.

resourceStatus

Instance resourceStatus.

satisfiesPzs

Instance satisfiesPzs.

scheduling

Instance scheduling.

Instance selfLink.

serviceAccounts

Instance serviceAccounts.

shieldedInstanceConfig

Instance shieldedInstanceConfig.

shieldedInstanceIntegrityPolicy

Instance shieldedInstanceIntegrityPolicy.

sourceMachineImage

Instance sourceMachineImage.

sourceMachineImageEncryptionKey

Instance sourceMachineImageEncryptionKey.

startRestricted

Instance startRestricted.

status

Instance status.

statusMessage

Instance statusMessage.

tags

Instance tags.

zone

Instance zone.

KeyRevocationActionType

KeyRevocationActionType enum.

Properties:
Name Type Description
UNDEFINED_KEY_REVOCATION_ACTION_TYPE number

UNDEFINED_KEY_REVOCATION_ACTION_TYPE value

KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED number

KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED value

NONE number

NONE value

STOP number

STOP value

PrivateIpv6GoogleAccess

PrivateIpv6GoogleAccess enum.

Properties:
Name Type Description
UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS number

UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS value

ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE number

ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE value

ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE number

ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE value

INHERIT_FROM_SUBNETWORK number

INHERIT_FROM_SUBNETWORK value

Status

Status enum.

Properties:
Name Type Description
UNDEFINED_STATUS number

UNDEFINED_STATUS value

DEPROVISIONING number

DEPROVISIONING value

PROVISIONING number

PROVISIONING value

REPAIRING number

REPAIRING value

RUNNING number

RUNNING value

STAGING number

STAGING value

STOPPED number

STOPPED value

STOPPING number

STOPPING value

SUSPENDED number

SUSPENDED value

SUSPENDING number

SUSPENDING value

TERMINATED number

TERMINATED value

Methods

toJSON() → {Object.<string, *>}

Converts this Instance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.Instance}

Creates a new Instance instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IInstance <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.Instance

Instance instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.Instance}

Decodes an Instance message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.Instance

Instance

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.Instance}

Decodes an Instance message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.Instance

Instance

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Instance message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IInstance

Instance message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Instance message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IInstance

Instance message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.Instance}

Creates an Instance message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.Instance

Instance

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Instance

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an Instance message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.Instance

Instance

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an Instance message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not