Instance

google.cloud.osconfig.v1. Instance

Represents an Instance.

Constructor

new Instance(propertiesopt)

Constructs a new Instance.

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

Properties to set
Implements:
  • IInstance

Members

PatchState

PatchState enum.

Properties:
Name Type Description
PATCH_STATE_UNSPECIFIED number

PATCH_STATE_UNSPECIFIED value
PENDING number

PENDING value
INACTIVE number

INACTIVE value
NOTIFIED number

NOTIFIED value
STARTED number

STARTED value
DOWNLOADING_PATCHES number

DOWNLOADING_PATCHES value
APPLYING_PATCHES number

APPLYING_PATCHES value
REBOOTING number

REBOOTING value
SUCCEEDED number

SUCCEEDED value
SUCCEEDED_REBOOT_REQUIRED number

SUCCEEDED_REBOOT_REQUIRED value
FAILED number

FAILED value
ACKED number

ACKED value
TIMED_OUT number

TIMED_OUT value
RUNNING_PRE_PATCH_STEP number

RUNNING_PRE_PATCH_STEP value
RUNNING_POST_PATCH_STEP number

RUNNING_POST_PATCH_STEP value
NO_AGENT_DETECTED number

NO_AGENT_DETECTED value

Methods

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

Creates a new Instance instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.osconfig.v1.Instance

Instance instance

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

Decodes an Instance 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.Instance

Instance
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.Instance}

Decodes an Instance 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.Instance

Instance
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 Instance message. Does not implicitly verify messages.

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

Instance 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 Instance message, length delimited. Does not implicitly verify messages.

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

Instance 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.Instance}

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

Instance

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

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

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

Instance
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies an Instance 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

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

Converts this Instance to JSON.

Returns:
Type Description
Object.<string, *>

JSON object