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

Represents a BootDisk.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

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

Constructs a new BootDisk.

Parameter
Name Description
properties IBootDisk

Properties to set

Properties

diskEncryption

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

BootDisk diskEncryption.

diskSizeGb

public diskSizeGb: (number|Long|string);

BootDisk diskSizeGb.

diskType

public diskType: (google.cloud.notebooks.v2.DiskType|keyof typeof google.cloud.notebooks.v2.DiskType);

BootDisk diskType.

kmsKey

public kmsKey: string;

BootDisk kmsKey.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v2.IBootDisk): google.cloud.notebooks.v2.BootDisk;

Creates a new BootDisk instance using the specified properties.

Parameter
Name Description
properties IBootDisk

Properties to set

Returns
Type Description
BootDisk

BootDisk instance

decode(reader, length)

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

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

BootDisk

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BootDisk

BootDisk

encode(message, writer)

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

Encodes the specified BootDisk message. Does not implicitly messages.

Parameters
Name Description
message IBootDisk

BootDisk 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.IBootDisk, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBootDisk

BootDisk 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.BootDisk;

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

BootDisk

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BootDisk

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BootDisk

BootDisk

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