Class protos.google.cloud.notebooks.v1beta1.Instance (1.1.7)

Represents an Instance.

Package

@google-cloud/notebooks!

Constructors

(constructor)(properties)

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

Constructs a new Instance.

Parameter

Name	Description
properties	`IInstance` Properties to set

Properties

acceleratorConfig

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

Instance acceleratorConfig.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.Instance.IAcceleratorConfig\|null)

bootDiskSizeGb

public bootDiskSizeGb: (number|Long|string);

Instance bootDiskSizeGb.

Property Value

Type	Description
(number\|Long\|string)

bootDiskType

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

Instance bootDiskType.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.Instance.DiskType\|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskType)

containerImage

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

Instance containerImage.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.IContainerImage\|null)

createTime

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

Instance createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

customGpuDriverPath

public customGpuDriverPath: string;

Instance customGpuDriverPath.

Property Value

Type	Description
string

dataDiskSizeGb

public dataDiskSizeGb: (number|Long|string);

Instance dataDiskSizeGb.

Property Value

Type	Description
(number\|Long\|string)

dataDiskType

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

Instance dataDiskType.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.Instance.DiskType\|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskType)

diskEncryption

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

Instance diskEncryption.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.Instance.DiskEncryption\|keyof typeof google.cloud.notebooks.v1beta1.Instance.DiskEncryption)

environment

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

Instance environment.

Property Value

Type	Description
("vmImage"\|"containerImage")

installGpuDriver

public installGpuDriver: boolean;

Instance installGpuDriver.

Property Value

Type	Description
boolean

instanceOwners

public instanceOwners: string[];

Instance instanceOwners.

Property Value

Type	Description
string[]

kmsKey

public kmsKey: string;

Instance kmsKey.

Property Value

Type	Description
string

labels

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

Instance labels.

Property Value

Type	Description
{ [k: string]: string }

machineType

public machineType: string;

Instance machineType.

Property Value

Type	Description
string

metadata

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

Instance metadata.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

Instance name.

Property Value

Type	Description
string

network

public network: string;

Instance network.

Property Value

Type	Description
string

noProxyAccess

public noProxyAccess: boolean;

Instance noProxyAccess.

Property Value

Type	Description
boolean

noPublicIp

public noPublicIp: boolean;

Instance noPublicIp.

Property Value

Type	Description
boolean

noRemoveDataDisk

public noRemoveDataDisk: boolean;

Instance noRemoveDataDisk.

Property Value

Type	Description
boolean

postStartupScript

public postStartupScript: string;

Instance postStartupScript.

Property Value

Type	Description
string

proxyUri

public proxyUri: string;

Instance proxyUri.

Property Value

Type	Description
string

serviceAccount

public serviceAccount: string;

Instance serviceAccount.

Property Value

Type	Description
string

state

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

Instance state.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.Instance.State\|keyof typeof google.cloud.notebooks.v1beta1.Instance.State)

subnet

public subnet: string;

Instance subnet.

Property Value

Type	Description
string

updateTime

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

Instance updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

vmImage

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

Instance vmImage.

Property Value

Type	Description
(google.cloud.notebooks.v1beta1.IVmImage\|null)

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1beta1.IInstance): google.cloud.notebooks.v1beta1.Instance;

Creates a new Instance instance using the specified properties.

Parameter

Name	Description
properties	`IInstance` Properties to set

Returns

Type	Description
google.cloud.notebooks.v1beta1.Instance	Instance instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.notebooks.v1beta1.Instance;

Decodes an Instance message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.notebooks.v1beta1.Instance	Instance

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.notebooks.v1beta1.Instance;

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.notebooks.v1beta1.Instance	Instance

encode(message, writer)

public static encode(message: google.cloud.notebooks.v1beta1.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.v1beta1.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.v1beta1.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
google.cloud.notebooks.v1beta1.Instance	Instance

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.v1beta1.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	`google.cloud.notebooks.v1beta1.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