Class protos.google.cloud.compute.v1.SuspendInstanceRequest (4.6.0)

Represents a SuspendInstanceRequest.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new SuspendInstanceRequest.

Parameter
Name Description
properties ISuspendInstanceRequest

Properties to set

Properties

_discardLocalSsd

public _discardLocalSsd?: "discardLocalSsd";

SuspendInstanceRequest _discardLocalSsd.

_requestId

public _requestId?: "requestId";

SuspendInstanceRequest _requestId.

discardLocalSsd

public discardLocalSsd?: (boolean|null);

SuspendInstanceRequest discardLocalSsd.

instance

public instance: string;

SuspendInstanceRequest instance.

project

public project: string;

SuspendInstanceRequest project.

requestId

public requestId?: (string|null);

SuspendInstanceRequest requestId.

zone

public zone: string;

SuspendInstanceRequest zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.ISuspendInstanceRequest): google.cloud.compute.v1.SuspendInstanceRequest;

Creates a new SuspendInstanceRequest instance using the specified properties.

Parameter
Name Description
properties ISuspendInstanceRequest

Properties to set

Returns
Type Description
SuspendInstanceRequest

SuspendInstanceRequest instance

decode(reader, length)

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

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

SuspendInstanceRequest

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
SuspendInstanceRequest

SuspendInstanceRequest

encode(message, writer)

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

Encodes the specified SuspendInstanceRequest message. Does not implicitly messages.

Parameters
Name Description
message ISuspendInstanceRequest

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

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

Parameters
Name Description
message ISuspendInstanceRequest

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

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

SuspendInstanceRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for SuspendInstanceRequest

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message SuspendInstanceRequest

SuspendInstanceRequest

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