Class protos.google.cloud.notebooks.v1.Instance.Disk

Represents a Disk.

Package

@google-cloud/notebooks

Constructors

(constructor)(properties)

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

Constructs a new Disk.

Parameter
NameDescription
properties IDisk

Properties to set

Properties

autoDelete

public autoDelete: boolean;

Disk autoDelete.

boot

public boot: boolean;

Disk boot.

deviceName

public deviceName: string;

Disk deviceName.

diskSizeGb

public diskSizeGb: (number|Long|string);

Disk diskSizeGb.

guestOsFeatures

public guestOsFeatures: google.cloud.notebooks.v1.Instance.Disk.IGuestOsFeature[];

Disk guestOsFeatures.

index

public index: (number|Long|string);

Disk index.

interface

public interface: string;

Disk interface.

kind

public kind: string;

Disk kind.

licenses

public licenses: string[];

Disk licenses.

mode

public mode: string;

Disk mode.

source

public source: string;

Disk source.

type

public type: string;

Disk type.

Methods

create(properties)

public static create(properties?: google.cloud.notebooks.v1.Instance.IDisk): google.cloud.notebooks.v1.Instance.Disk;

Creates a new Disk instance using the specified properties.

Parameter
NameDescription
properties IDisk

Properties to set

Returns
TypeDescription
google.cloud.notebooks.v1.Instance.Disk

Disk instance

decode(reader, length)

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

Decodes a Disk message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.notebooks.v1.Instance.Disk

Disk

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.notebooks.v1.Instance.Disk

Disk

encode(message, writer)

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

Encodes the specified Disk message. Does not implicitly messages.

Parameters
NameDescription
message IDisk

Disk message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.notebooks.v1.Instance.IDisk, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IDisk

Disk message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.notebooks.v1.Instance.Disk;

Creates a Disk message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.notebooks.v1.Instance.Disk

Disk

toJSON()

public toJSON(): { [k: string]: any };

Converts this Disk to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.notebooks.v1.Instance.Disk

Disk

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Disk message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not