Class protos.google.appengine.v1.Instance (1.1.0)

Represents an Instance.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.appengine.v1.IInstance);

Constructs a new Instance.

Parameter

Name	Description
properties	`IInstance` Properties to set

Properties

appEngineRelease

public appEngineRelease: string;

Instance appEngineRelease.

availability

public availability: (google.appengine.v1.Instance.Availability|keyof typeof google.appengine.v1.Instance.Availability);

Instance availability.

averageLatency

public averageLatency: number;

Instance averageLatency.

errors

public errors: number;

Instance errors.

id

public id: string;

Instance id.

memoryUsage

public memoryUsage: (number|Long|string);

Instance memoryUsage.

name

public name: string;

Instance name.

qps

public qps: number;

Instance qps.

requests

public requests: number;

Instance requests.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

Instance startTime.

vmDebugEnabled

public vmDebugEnabled: boolean;

Instance vmDebugEnabled.

vmId

public vmId: string;

Instance vmId.

vmIp

public vmIp: string;

Instance vmIp.

vmLiveness

public vmLiveness: (google.appengine.v1.Instance.Liveness.LivenessState|keyof typeof google.appengine.v1.Instance.Liveness.LivenessState);

Instance vmLiveness.

vmName

public vmName: string;

Instance vmName.

vmStatus

public vmStatus: string;

Instance vmStatus.

vmZoneName

public vmZoneName: string;

Instance vmZoneName.

Methods

create(properties)

public static create(properties?: google.appengine.v1.IInstance): google.appengine.v1.Instance;

Creates a new Instance instance using the specified properties.

Parameter

Name	Description
properties	`IInstance` Properties to set

Returns

Type	Description
google.appengine.v1.Instance	Instance instance

decode(reader, length)

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

Decodes an Instance message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.appengine.v1.Instance	Instance

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.appengine.v1.Instance	Instance

encode(message, writer)

public static encode(message: google.appengine.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Instance message. Does not implicitly messages.

Parameters

Name	Description
message	`IInstance` Instance 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.appengine.v1.IInstance, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IInstance` Instance 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.appengine.v1.Instance;

Creates an Instance 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
google.appengine.v1.Instance	Instance

toJSON()

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

Converts this Instance to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.appengine.v1.Instance` Instance
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 Instance 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