PatchJob

google.cloud.osconfig.v1. PatchJob

Represents a PatchJob.

Constructor

new PatchJob(propertiesopt)

Constructs a new PatchJob.

Parameters:
Name Type Attributes Description
properties google.cloud.osconfig.v1.IPatchJob <optional>

Properties to set

Implements:
  • IPatchJob

Classes

InstanceDetailsSummary

Members

createTime

PatchJob createTime.

description

PatchJob description.

displayName

PatchJob displayName.

dryRun

PatchJob dryRun.

duration

PatchJob duration.

errorMessage

PatchJob errorMessage.

instanceDetailsSummary

PatchJob instanceDetailsSummary.

instanceFilter

PatchJob instanceFilter.

name

PatchJob name.

patchConfig

PatchJob patchConfig.

patchDeployment

PatchJob patchDeployment.

percentComplete

PatchJob percentComplete.

rollout

PatchJob rollout.

state

PatchJob state.

updateTime

PatchJob updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

STARTED number

STARTED value

INSTANCE_LOOKUP number

INSTANCE_LOOKUP value

PATCHING number

PATCHING value

SUCCEEDED number

SUCCEEDED value

COMPLETED_WITH_ERRORS number

COMPLETED_WITH_ERRORS value

CANCELED number

CANCELED value

TIMED_OUT number

TIMED_OUT value

Methods

toJSON() → {Object.<string, *>}

Converts this PatchJob to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.osconfig.v1.PatchJob}

Creates a new PatchJob instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.osconfig.v1.IPatchJob <optional>

Properties to set

Returns:
Type Description
google.cloud.osconfig.v1.PatchJob

PatchJob instance

(static) decode(reader, lengthopt) → {google.cloud.osconfig.v1.PatchJob}

Decodes a PatchJob message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.osconfig.v1.PatchJob

PatchJob

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.osconfig.v1.PatchJob}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.osconfig.v1.PatchJob

PatchJob

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified PatchJob message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1.IPatchJob

PatchJob message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1.IPatchJob

PatchJob message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.osconfig.v1.PatchJob}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.osconfig.v1.PatchJob

PatchJob

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for PatchJob

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.osconfig.v1.PatchJob

PatchJob

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a PatchJob message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not