Class protos.google.cloud.compute.v1.AttachedDisk (4.3.0)

Represents an AttachedDisk.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IAttachedDisk);

Constructs a new AttachedDisk.

Parameter
NameDescription
properties IAttachedDisk

Properties to set

Properties

_architecture

public _architecture?: "architecture";

AttachedDisk _architecture.

_autoDelete

public _autoDelete?: "autoDelete";

AttachedDisk _autoDelete.

_boot

public _boot?: "boot";

AttachedDisk _boot.

_deviceName

public _deviceName?: "deviceName";

AttachedDisk _deviceName.

_diskEncryptionKey

public _diskEncryptionKey?: "diskEncryptionKey";

AttachedDisk _diskEncryptionKey.

_diskSizeGb

public _diskSizeGb?: "diskSizeGb";

AttachedDisk _diskSizeGb.

_forceAttach

public _forceAttach?: "forceAttach";

AttachedDisk _forceAttach.

_index

public _index?: "index";

AttachedDisk _index.

_initializeParams

public _initializeParams?: "initializeParams";

AttachedDisk _initializeParams.

_interface

public _interface?: "interface";

AttachedDisk _interface.

_kind

public _kind?: "kind";

AttachedDisk _kind.

_mode

public _mode?: "mode";

AttachedDisk _mode.

_savedState

public _savedState?: "savedState";

AttachedDisk _savedState.

_shieldedInstanceInitialState

public _shieldedInstanceInitialState?: "shieldedInstanceInitialState";

AttachedDisk _shieldedInstanceInitialState.

_source

public _source?: "source";

AttachedDisk _source.

_type

public _type?: "type";

AttachedDisk _type.

architecture

public architecture?: (string|null);

AttachedDisk architecture.

autoDelete

public autoDelete?: (boolean|null);

AttachedDisk autoDelete.

boot

public boot?: (boolean|null);

AttachedDisk boot.

deviceName

public deviceName?: (string|null);

AttachedDisk deviceName.

diskEncryptionKey

public diskEncryptionKey?: (google.cloud.compute.v1.ICustomerEncryptionKey|null);

AttachedDisk diskEncryptionKey.

diskSizeGb

public diskSizeGb?: (number|Long|string|null);

AttachedDisk diskSizeGb.

forceAttach

public forceAttach?: (boolean|null);

AttachedDisk forceAttach.

guestOsFeatures

public guestOsFeatures: google.cloud.compute.v1.IGuestOsFeature[];

AttachedDisk guestOsFeatures.

index

public index?: (number|null);

AttachedDisk index.

initializeParams

public initializeParams?: (google.cloud.compute.v1.IAttachedDiskInitializeParams|null);

AttachedDisk initializeParams.

interface

public interface?: (string|null);

AttachedDisk interface.

kind

public kind?: (string|null);

AttachedDisk kind.

licenses

public licenses: string[];

AttachedDisk licenses.

mode

public mode?: (string|null);

AttachedDisk mode.

savedState

public savedState?: (string|null);

AttachedDisk savedState.

shieldedInstanceInitialState

public shieldedInstanceInitialState?: (google.cloud.compute.v1.IInitialStateConfig|null);

AttachedDisk shieldedInstanceInitialState.

source

public source?: (string|null);

AttachedDisk source.

type

public type?: (string|null);

AttachedDisk type.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAttachedDisk): google.cloud.compute.v1.AttachedDisk;

Creates a new AttachedDisk instance using the specified properties.

Parameter
NameDescription
properties IAttachedDisk

Properties to set

Returns
TypeDescription
AttachedDisk

AttachedDisk instance

decode(reader, length)

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

Decodes an AttachedDisk message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
AttachedDisk

AttachedDisk

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
AttachedDisk

AttachedDisk

encode(message, writer)

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

Encodes the specified AttachedDisk message. Does not implicitly messages.

Parameters
NameDescription
message IAttachedDisk

AttachedDisk 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.compute.v1.IAttachedDisk, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAttachedDisk

AttachedDisk 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.compute.v1.AttachedDisk;

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

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

Plain object

Returns
TypeDescription
AttachedDisk

AttachedDisk

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AttachedDisk

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this AttachedDisk to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message AttachedDisk

AttachedDisk

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AttachedDisk 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