Class protos.google.cloud.notebooks.v1.Instance (4.0.1)

Represents an Instance.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.notebooks.v1.IInstance);

Constructs a new Instance.

Parameter
Name Description
properties IInstance

Properties to set

Properties

acceleratorConfig

public acceleratorConfig?: (google.cloud.notebooks.v1.Instance.IAcceleratorConfig|null);

Instance acceleratorConfig.

bootDiskSizeGb

public bootDiskSizeGb: (number|Long|string);

Instance bootDiskSizeGb.

bootDiskType

public bootDiskType: (google.cloud.notebooks.v1.Instance.DiskType|keyof typeof google.cloud.notebooks.v1.Instance.DiskType);

Instance bootDiskType.

canIpForward

public canIpForward: boolean;

Instance canIpForward.

containerImage

public containerImage?: (google.cloud.notebooks.v1.IContainerImage|null);

Instance containerImage.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

Instance createTime.

creator

public creator: string;

Instance creator.

customGpuDriverPath

public customGpuDriverPath: string;

Instance customGpuDriverPath.

dataDiskSizeGb

public dataDiskSizeGb: (number|Long|string);

Instance dataDiskSizeGb.

dataDiskType

public dataDiskType: (google.cloud.notebooks.v1.Instance.DiskType|keyof typeof google.cloud.notebooks.v1.Instance.DiskType);

Instance dataDiskType.

diskEncryption

public diskEncryption: (google.cloud.notebooks.v1.Instance.DiskEncryption|keyof typeof google.cloud.notebooks.v1.Instance.DiskEncryption);

Instance diskEncryption.

disks

public disks: google.cloud.notebooks.v1.Instance.IDisk[];

Instance disks.

environment

public environment?: ("vmImage"|"containerImage");

Instance environment.

installGpuDriver

public installGpuDriver: boolean;

Instance installGpuDriver.

instanceOwners

public instanceOwners: string[];

Instance instanceOwners.

kmsKey

public kmsKey: string;

Instance kmsKey.

labels

public labels: { [k: string]: string };

Instance labels.

machineType

public machineType: string;

Instance machineType.

metadata

public metadata: { [k: string]: string };

Instance metadata.

name

public name: string;

Instance name.

network

public network: string;

Instance network.

nicType

public nicType: (google.cloud.notebooks.v1.Instance.NicType|keyof typeof google.cloud.notebooks.v1.Instance.NicType);

Instance nicType.

noProxyAccess

public noProxyAccess: boolean;

Instance noProxyAccess.

noPublicIp

public noPublicIp: boolean;

Instance noPublicIp.

noRemoveDataDisk

public noRemoveDataDisk: boolean;

Instance noRemoveDataDisk.

postStartupScript

public postStartupScript: string;

Instance postStartupScript.

proxyUri

public proxyUri: string;

Instance proxyUri.

reservationAffinity

public reservationAffinity?: (google.cloud.notebooks.v1.IReservationAffinity|null);

Instance reservationAffinity.

serviceAccount

public serviceAccount: string;

Instance serviceAccount.

serviceAccountScopes

public serviceAccountScopes: string[];

Instance serviceAccountScopes.

shieldedInstanceConfig

public shieldedInstanceConfig?: (google.cloud.notebooks.v1.Instance.IShieldedInstanceConfig|null);

Instance shieldedInstanceConfig.

state

public state: (google.cloud.notebooks.v1.Instance.State|keyof typeof google.cloud.notebooks.v1.Instance.State);

Instance state.

subnet

public subnet: string;

Instance subnet.

tags

public tags: string[];

Instance tags.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Instance updateTime.

upgradeHistory

public upgradeHistory: google.cloud.notebooks.v1.Instance.IUpgradeHistoryEntry[];

Instance upgradeHistory.

vmImage

public vmImage?: (google.cloud.notebooks.v1.IVmImage|null);

Instance vmImage.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1.IInstance): google.cloud.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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.notebooks.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)

null if valid, otherwise the reason why it is not