Class protos.google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary (2.2.2)

Represents an InstanceDetailsSummary.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.osconfig.v1.PatchJob.IInstanceDetailsSummary);

Constructs a new InstanceDetailsSummary.

Parameter
Name	Description
`properties`	`IInstanceDetailsSummary` Properties to set

Properties

ackedInstanceCount

public ackedInstanceCount: (number|Long|string);

InstanceDetailsSummary ackedInstanceCount.

applyingPatchesInstanceCount

public applyingPatchesInstanceCount: (number|Long|string);

InstanceDetailsSummary applyingPatchesInstanceCount.

downloadingPatchesInstanceCount

public downloadingPatchesInstanceCount: (number|Long|string);

InstanceDetailsSummary downloadingPatchesInstanceCount.

failedInstanceCount

public failedInstanceCount: (number|Long|string);

InstanceDetailsSummary failedInstanceCount.

inactiveInstanceCount

public inactiveInstanceCount: (number|Long|string);

InstanceDetailsSummary inactiveInstanceCount.

noAgentDetectedInstanceCount

public noAgentDetectedInstanceCount: (number|Long|string);

InstanceDetailsSummary noAgentDetectedInstanceCount.

notifiedInstanceCount

public notifiedInstanceCount: (number|Long|string);

InstanceDetailsSummary notifiedInstanceCount.

pendingInstanceCount

public pendingInstanceCount: (number|Long|string);

InstanceDetailsSummary pendingInstanceCount.

postPatchStepInstanceCount

public postPatchStepInstanceCount: (number|Long|string);

InstanceDetailsSummary postPatchStepInstanceCount.

prePatchStepInstanceCount

public prePatchStepInstanceCount: (number|Long|string);

InstanceDetailsSummary prePatchStepInstanceCount.

rebootingInstanceCount

public rebootingInstanceCount: (number|Long|string);

InstanceDetailsSummary rebootingInstanceCount.

startedInstanceCount

public startedInstanceCount: (number|Long|string);

InstanceDetailsSummary startedInstanceCount.

succeededInstanceCount

public succeededInstanceCount: (number|Long|string);

InstanceDetailsSummary succeededInstanceCount.

succeededRebootRequiredInstanceCount

public succeededRebootRequiredInstanceCount: (number|Long|string);

InstanceDetailsSummary succeededRebootRequiredInstanceCount.

timedOutInstanceCount

public timedOutInstanceCount: (number|Long|string);

InstanceDetailsSummary timedOutInstanceCount.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1.PatchJob.IInstanceDetailsSummary): google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary;

Creates a new InstanceDetailsSummary instance using the specified properties.

Parameter
Name	Description
`properties`	`IInstanceDetailsSummary` Properties to set

Returns
Type	Description
`google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary`	InstanceDetailsSummary instance

decode(reader, length)

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

Decodes an InstanceDetailsSummary 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.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary`	InstanceDetailsSummary

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary;

Decodes an InstanceDetailsSummary 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.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary`	InstanceDetailsSummary

encode(message, writer)

public static encode(message: google.cloud.osconfig.v1.PatchJob.IInstanceDetailsSummary, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified InstanceDetailsSummary message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IInstanceDetailsSummary` InstanceDetailsSummary 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.osconfig.v1.PatchJob.IInstanceDetailsSummary, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IInstanceDetailsSummary` InstanceDetailsSummary 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.osconfig.v1.PatchJob.InstanceDetailsSummary;

Creates an InstanceDetailsSummary 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.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary`	InstanceDetailsSummary

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for InstanceDetailsSummary

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

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

toObject(message, options)

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

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

Parameters
Name	Description
`message`	`google.cloud.osconfig.v1.PatchJob.InstanceDetailsSummary` InstanceDetailsSummary
`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 InstanceDetailsSummary 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