Class protos.google.cloud.osconfig.v1.PatchConfig

Represents a PatchConfig.

Package

@google-cloud/os-config

Constructors

(constructor)(properties)

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

Constructs a new PatchConfig.

Parameter
NameDescription
properties IPatchConfig

Properties to set

Properties

apt

public apt?: (google.cloud.osconfig.v1.IAptSettings|null);

PatchConfig apt.

goo

public goo?: (google.cloud.osconfig.v1.IGooSettings|null);

PatchConfig goo.

postStep

public postStep?: (google.cloud.osconfig.v1.IExecStep|null);

PatchConfig postStep.

preStep

public preStep?: (google.cloud.osconfig.v1.IExecStep|null);

PatchConfig preStep.

rebootConfig

public rebootConfig: (google.cloud.osconfig.v1.PatchConfig.RebootConfig|keyof typeof google.cloud.osconfig.v1.PatchConfig.RebootConfig);

PatchConfig rebootConfig.

windowsUpdate

public windowsUpdate?: (google.cloud.osconfig.v1.IWindowsUpdateSettings|null);

PatchConfig windowsUpdate.

yum

public yum?: (google.cloud.osconfig.v1.IYumSettings|null);

PatchConfig yum.

zypper

public zypper?: (google.cloud.osconfig.v1.IZypperSettings|null);

PatchConfig zypper.

Methods

create(properties)

public static create(properties?: google.cloud.osconfig.v1.IPatchConfig): google.cloud.osconfig.v1.PatchConfig;

Creates a new PatchConfig instance using the specified properties.

Parameter
NameDescription
properties IPatchConfig

Properties to set

Returns
TypeDescription
google.cloud.osconfig.v1.PatchConfig

PatchConfig instance

decode(reader, length)

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

Decodes a PatchConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.osconfig.v1.PatchConfig

PatchConfig

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.osconfig.v1.PatchConfig

PatchConfig

encode(message, writer)

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

Encodes the specified PatchConfig message. Does not implicitly messages.

Parameters
NameDescription
message IPatchConfig

PatchConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IPatchConfig

PatchConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.osconfig.v1.PatchConfig;

Creates a PatchConfig message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.osconfig.v1.PatchConfig

PatchConfig

toJSON()

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

Converts this PatchConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.osconfig.v1.PatchConfig

PatchConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a PatchConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not