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

Represents a ManagedInstance.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

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

Constructs a new ManagedInstance.

Parameter
Name Description
properties IManagedInstance

Properties to set

Properties

_currentAction

public _currentAction?: "currentAction";

ManagedInstance _currentAction.

_id

public _id?: "id";

ManagedInstance _id.

_instance

public _instance?: "instance";

ManagedInstance _instance.

_instanceStatus

public _instanceStatus?: "instanceStatus";

ManagedInstance _instanceStatus.

_lastAttempt

public _lastAttempt?: "lastAttempt";

ManagedInstance _lastAttempt.

_name

public _name?: "name";

ManagedInstance _name.

_preservedStateFromConfig

public _preservedStateFromConfig?: "preservedStateFromConfig";

ManagedInstance _preservedStateFromConfig.

_preservedStateFromPolicy

public _preservedStateFromPolicy?: "preservedStateFromPolicy";

ManagedInstance _preservedStateFromPolicy.

_version

public _version?: "version";

ManagedInstance _version.

currentAction

public currentAction?: (string|null);

ManagedInstance currentAction.

id

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

ManagedInstance id.

instance

public instance?: (string|null);

ManagedInstance instance.

instanceHealth

public instanceHealth: google.cloud.compute.v1.IManagedInstanceInstanceHealth[];

ManagedInstance instanceHealth.

instanceStatus

public instanceStatus?: (string|null);

ManagedInstance instanceStatus.

lastAttempt

public lastAttempt?: (google.cloud.compute.v1.IManagedInstanceLastAttempt|null);

ManagedInstance lastAttempt.

name

public name?: (string|null);

ManagedInstance name.

preservedStateFromConfig

public preservedStateFromConfig?: (google.cloud.compute.v1.IPreservedState|null);

ManagedInstance preservedStateFromConfig.

preservedStateFromPolicy

public preservedStateFromPolicy?: (google.cloud.compute.v1.IPreservedState|null);

ManagedInstance preservedStateFromPolicy.

version

public version?: (google.cloud.compute.v1.IManagedInstanceVersion|null);

ManagedInstance version.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IManagedInstance): google.cloud.compute.v1.ManagedInstance;

Creates a new ManagedInstance instance using the specified properties.

Parameter
Name Description
properties IManagedInstance

Properties to set

Returns
Type Description
ManagedInstance

ManagedInstance instance

decode(reader, length)

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

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

ManagedInstance

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ManagedInstance

ManagedInstance

encode(message, writer)

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

Encodes the specified ManagedInstance message. Does not implicitly messages.

Parameters
Name Description
message IManagedInstance

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

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

Parameters
Name Description
message IManagedInstance

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

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

ManagedInstance

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for ManagedInstance

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message ManagedInstance

ManagedInstance

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