Instance

google.cloud.notebooks.v1. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

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

Properties to set
Implements:
  • IInstance

Classes

AcceleratorConfig
Disk
ShieldedInstanceConfig
UpgradeHistoryEntry

Members

acceleratorConfig

Instance acceleratorConfig.

bootDiskSizeGb

Instance bootDiskSizeGb.

bootDiskType

Instance bootDiskType.

canIpForward

Instance canIpForward.

containerImage

Instance containerImage.

createTime

Instance createTime.

creator

Instance creator.

customGpuDriverPath

Instance customGpuDriverPath.

dataDiskSizeGb

Instance dataDiskSizeGb.

dataDiskType

Instance dataDiskType.

diskEncryption

Instance diskEncryption.

disks

Instance disks.

environment

Instance environment.

installGpuDriver

Instance installGpuDriver.

instanceOwners

Instance instanceOwners.

kmsKey

Instance kmsKey.

labels

Instance labels.

machineType

Instance machineType.

metadata

Instance metadata.

name

Instance name.

network

Instance network.

nicType

Instance nicType.

noProxyAccess

Instance noProxyAccess.

noPublicIp

Instance noPublicIp.

noRemoveDataDisk

Instance noRemoveDataDisk.

postStartupScript

Instance postStartupScript.

proxyUri

Instance proxyUri.

reservationAffinity

Instance reservationAffinity.

serviceAccount

Instance serviceAccount.

serviceAccountScopes

Instance serviceAccountScopes.

shieldedInstanceConfig

Instance shieldedInstanceConfig.

state

Instance state.

subnet

Instance subnet.

tags

Instance tags.

updateTime

Instance updateTime.

upgradeHistory

Instance upgradeHistory.

vmImage

Instance vmImage.

AcceleratorType

AcceleratorType enum.

Properties:
Name Type Description
ACCELERATOR_TYPE_UNSPECIFIED number

ACCELERATOR_TYPE_UNSPECIFIED value
NVIDIA_TESLA_K80 number

NVIDIA_TESLA_K80 value
NVIDIA_TESLA_P100 number

NVIDIA_TESLA_P100 value
NVIDIA_TESLA_V100 number

NVIDIA_TESLA_V100 value
NVIDIA_TESLA_P4 number

NVIDIA_TESLA_P4 value
NVIDIA_TESLA_T4 number

NVIDIA_TESLA_T4 value
NVIDIA_TESLA_A100 number

NVIDIA_TESLA_A100 value
NVIDIA_TESLA_T4_VWS number

NVIDIA_TESLA_T4_VWS value
NVIDIA_TESLA_P100_VWS number

NVIDIA_TESLA_P100_VWS value
NVIDIA_TESLA_P4_VWS number

NVIDIA_TESLA_P4_VWS value
TPU_V2 number

TPU_V2 value
TPU_V3 number

TPU_V3 value

DiskEncryption

DiskEncryption enum.

Properties:
Name Type Description
DISK_ENCRYPTION_UNSPECIFIED number

DISK_ENCRYPTION_UNSPECIFIED value
GMEK number

GMEK value
CMEK number

CMEK value

DiskType

DiskType enum.

Properties:
Name Type Description
DISK_TYPE_UNSPECIFIED number

DISK_TYPE_UNSPECIFIED value
PD_STANDARD number

PD_STANDARD value
PD_SSD number

PD_SSD value
PD_BALANCED number

PD_BALANCED value
PD_EXTREME number

PD_EXTREME value

NicType

NicType enum.

Properties:
Name Type Description
UNSPECIFIED_NIC_TYPE number

UNSPECIFIED_NIC_TYPE value
VIRTIO_NET number

VIRTIO_NET value
GVNIC number

GVNIC value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value
STARTING number

STARTING value
PROVISIONING number

PROVISIONING value
ACTIVE number

ACTIVE value
STOPPING number

STOPPING value
STOPPED number

STOPPED value
DELETED number

DELETED value
UPGRADING number

UPGRADING value
INITIALIZING number

INITIALIZING value
REGISTERING number

REGISTERING value
SUSPENDING number

SUSPENDING value
SUSPENDED number

SUSPENDED value

Methods

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

Converts this Instance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Instance instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.notebooks.v1.Instance

Instance instance

(static) decode(reader, lengthopt) → {google.cloud.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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