Class protos.google.cloud.notebooks.v2.GceSetup (4.1.0)

Represents a GceSetup.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.notebooks.v2.IGceSetup);

Constructs a new GceSetup.

Parameter
Name Description
properties IGceSetup

Properties to set

Properties

acceleratorConfigs

public acceleratorConfigs: google.cloud.notebooks.v2.IAcceleratorConfig[];

GceSetup acceleratorConfigs.

bootDisk

public bootDisk?: (google.cloud.notebooks.v2.IBootDisk|null);

GceSetup bootDisk.

containerImage

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

GceSetup containerImage.

dataDisks

public dataDisks: google.cloud.notebooks.v2.IDataDisk[];

GceSetup dataDisks.

disablePublicIp

public disablePublicIp: boolean;

GceSetup disablePublicIp.

enableIpForwarding

public enableIpForwarding: boolean;

GceSetup enableIpForwarding.

gpuDriverConfig

public gpuDriverConfig?: (google.cloud.notebooks.v2.IGPUDriverConfig|null);

GceSetup gpuDriverConfig.

image

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

GceSetup image.

machineType

public machineType: string;

GceSetup machineType.

metadata

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

GceSetup metadata.

networkInterfaces

public networkInterfaces: google.cloud.notebooks.v2.INetworkInterface[];

GceSetup networkInterfaces.

serviceAccounts

public serviceAccounts: google.cloud.notebooks.v2.IServiceAccount[];

GceSetup serviceAccounts.

shieldedInstanceConfig

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

GceSetup shieldedInstanceConfig.

tags

public tags: string[];

GceSetup tags.

vmImage

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

GceSetup vmImage.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v2.IGceSetup): google.cloud.notebooks.v2.GceSetup;

Creates a new GceSetup instance using the specified properties.

Parameter
Name Description
properties IGceSetup

Properties to set

Returns
Type Description
GceSetup

GceSetup instance

decode(reader, length)

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

Decodes a GceSetup 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
GceSetup

GceSetup

decodeDelimited(reader)

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

Decodes a GceSetup message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
GceSetup

GceSetup

encode(message, writer)

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

Encodes the specified GceSetup message. Does not implicitly messages.

Parameters
Name Description
message IGceSetup

GceSetup 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.v2.IGceSetup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IGceSetup

GceSetup 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.v2.GceSetup;

Creates a GceSetup 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
GceSetup

GceSetup

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for GceSetup

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message GceSetup

GceSetup

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 GceSetup 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