Class protos.google.cloud.notebooks.v1.VirtualMachineConfig (2.1.4)

Represents a VirtualMachineConfig.

Package

Constructors

(constructor)(properties)

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

Constructs a new VirtualMachineConfig.

Parameter
Name	Description
`properties`	`IVirtualMachineConfig` Properties to set

Properties

acceleratorConfig

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

VirtualMachineConfig acceleratorConfig.

bootImage

public bootImage?: (google.cloud.notebooks.v1.VirtualMachineConfig.IBootImage|null);

VirtualMachineConfig bootImage.

containerImages

public containerImages: google.cloud.notebooks.v1.IContainerImage[];

VirtualMachineConfig containerImages.

dataDisk

public dataDisk?: (google.cloud.notebooks.v1.ILocalDisk|null);

VirtualMachineConfig dataDisk.

encryptionConfig

public encryptionConfig?: (google.cloud.notebooks.v1.IEncryptionConfig|null);

VirtualMachineConfig encryptionConfig.

guestAttributes

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

VirtualMachineConfig guestAttributes.

internalIpOnly

public internalIpOnly: boolean;

VirtualMachineConfig internalIpOnly.

labels

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

VirtualMachineConfig labels.

machineType

public machineType: string;

VirtualMachineConfig machineType.

metadata

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

VirtualMachineConfig metadata.

network

public network: string;

VirtualMachineConfig network.

nicType

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

VirtualMachineConfig nicType.

reservedIpRange

public reservedIpRange: string;

VirtualMachineConfig reservedIpRange.

shieldedInstanceConfig

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

VirtualMachineConfig shieldedInstanceConfig.

subnet

public subnet: string;

VirtualMachineConfig subnet.

zone

public zone: string;

VirtualMachineConfig zone.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1.IVirtualMachineConfig): google.cloud.notebooks.v1.VirtualMachineConfig;

Creates a new VirtualMachineConfig instance using the specified properties.

Parameter
Name	Description
`properties`	`IVirtualMachineConfig` Properties to set

Returns
Type	Description
`google.cloud.notebooks.v1.VirtualMachineConfig`	VirtualMachineConfig instance

decode(reader, length)

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

Decodes a VirtualMachineConfig 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.v1.VirtualMachineConfig`	VirtualMachineConfig

decodeDelimited(reader)

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

Decodes a VirtualMachineConfig 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.v1.VirtualMachineConfig`	VirtualMachineConfig

encode(message, writer)

public static encode(message: google.cloud.notebooks.v1.IVirtualMachineConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified VirtualMachineConfig message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IVirtualMachineConfig` VirtualMachineConfig 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.IVirtualMachineConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IVirtualMachineConfig` VirtualMachineConfig 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.VirtualMachineConfig;

Creates a VirtualMachineConfig 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.v1.VirtualMachineConfig`	VirtualMachineConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for VirtualMachineConfig

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 VirtualMachineConfig to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.notebooks.v1.VirtualMachineConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
`message`	`google.cloud.notebooks.v1.VirtualMachineConfig` VirtualMachineConfig
`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 a VirtualMachineConfig 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