Class protos.google.cloud.compute.v1.AttachDiskInstanceRequest (4.5.0)

Represents an AttachDiskInstanceRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new AttachDiskInstanceRequest.

Parameter
Name Description
properties IAttachDiskInstanceRequest

Properties to set

Properties

_forceAttach

public _forceAttach?: "forceAttach";

AttachDiskInstanceRequest _forceAttach.

_requestId

public _requestId?: "requestId";

AttachDiskInstanceRequest _requestId.

attachedDiskResource

public attachedDiskResource?: (google.cloud.compute.v1.IAttachedDisk|null);

AttachDiskInstanceRequest attachedDiskResource.

forceAttach

public forceAttach?: (boolean|null);

AttachDiskInstanceRequest forceAttach.

instance

public instance: string;

AttachDiskInstanceRequest instance.

project

public project: string;

AttachDiskInstanceRequest project.

requestId

public requestId?: (string|null);

AttachDiskInstanceRequest requestId.

zone

public zone: string;

AttachDiskInstanceRequest zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IAttachDiskInstanceRequest): google.cloud.compute.v1.AttachDiskInstanceRequest;

Creates a new AttachDiskInstanceRequest instance using the specified properties.

Parameter
Name Description
properties IAttachDiskInstanceRequest

Properties to set

Returns
Type Description
AttachDiskInstanceRequest

AttachDiskInstanceRequest instance

decode(reader, length)

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

Decodes an AttachDiskInstanceRequest 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
AttachDiskInstanceRequest

AttachDiskInstanceRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
AttachDiskInstanceRequest

AttachDiskInstanceRequest

encode(message, writer)

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

Encodes the specified AttachDiskInstanceRequest message. Does not implicitly messages.

Parameters
Name Description
message IAttachDiskInstanceRequest

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

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

Parameters
Name Description
message IAttachDiskInstanceRequest

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

Creates an AttachDiskInstanceRequest 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
AttachDiskInstanceRequest

AttachDiskInstanceRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for AttachDiskInstanceRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message AttachDiskInstanceRequest

AttachDiskInstanceRequest

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 an AttachDiskInstanceRequest 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