Class protos.google.cloud.osconfig.v1.PatchJob (1.11.0)

Represents a PatchJob.

Package

Constructors

(constructor)(properties)

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

Constructs a new PatchJob.

Parameter

Name	Description
properties	`IPatchJob` Properties to set

Properties

createTime

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

PatchJob createTime.

description

public description: string;

PatchJob description.

displayName

public displayName: string;

PatchJob displayName.

dryRun

public dryRun: boolean;

PatchJob dryRun.

duration

public duration?: (google.protobuf.IDuration|null);

PatchJob duration.

errorMessage

public errorMessage: string;

PatchJob errorMessage.

instanceDetailsSummary

public instanceDetailsSummary?: (google.cloud.osconfig.v1.PatchJob.IInstanceDetailsSummary|null);

PatchJob instanceDetailsSummary.

instanceFilter

public instanceFilter?: (google.cloud.osconfig.v1.IPatchInstanceFilter|null);

PatchJob instanceFilter.

name

public name: string;

PatchJob name.

patchConfig

public patchConfig?: (google.cloud.osconfig.v1.IPatchConfig|null);

PatchJob patchConfig.

patchDeployment

public patchDeployment: string;

PatchJob patchDeployment.

percentComplete

public percentComplete: number;

PatchJob percentComplete.

rollout

public rollout?: (google.cloud.osconfig.v1.IPatchRollout|null);

PatchJob rollout.

state

public state: (google.cloud.osconfig.v1.PatchJob.State|keyof typeof google.cloud.osconfig.v1.PatchJob.State);

PatchJob state.

updateTime

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

PatchJob updateTime.

Methods

create(properties)

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

Creates a new PatchJob instance using the specified properties.

Parameter

Name	Description
properties	`IPatchJob` Properties to set

Returns

Type	Description
google.cloud.osconfig.v1.PatchJob	PatchJob instance

decode(reader, length)

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

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

decodeDelimited(reader)

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

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

encode(message, writer)

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

Encodes the specified PatchJob message. Does not implicitly messages.

Parameters

Name	Description
message	`IPatchJob` PatchJob 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.IPatchJob, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPatchJob` PatchJob 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;

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

toJSON()

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

Converts this PatchJob to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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