PatchDeployment

google.cloud.osconfig.v1. PatchDeployment

Represents a PatchDeployment.

Constructor

new PatchDeployment(propertiesopt)

Constructs a new PatchDeployment.

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

Properties to set

Implements:
  • IPatchDeployment

Members

createTime

PatchDeployment createTime.

description

PatchDeployment description.

duration

PatchDeployment duration.

instanceFilter

PatchDeployment instanceFilter.

lastExecuteTime

PatchDeployment lastExecuteTime.

name

PatchDeployment name.

oneTimeSchedule

PatchDeployment oneTimeSchedule.

patchConfig

PatchDeployment patchConfig.

recurringSchedule

PatchDeployment recurringSchedule.

rollout

PatchDeployment rollout.

schedule

PatchDeployment schedule.

state

PatchDeployment state.

updateTime

PatchDeployment updateTime.

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ACTIVE number

ACTIVE value

PAUSED number

PAUSED value

Methods

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

Converts this PatchDeployment to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new PatchDeployment instance using the specified properties.

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

Properties to set

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

PatchDeployment instance

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

Decodes a PatchDeployment 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.PatchDeployment

PatchDeployment

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

Decodes a PatchDeployment 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.PatchDeployment

PatchDeployment

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

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

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

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

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

Creates a PatchDeployment 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.PatchDeployment

PatchDeployment

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for PatchDeployment

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 PatchDeployment message. Also converts values to other types if specified.

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

PatchDeployment

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a PatchDeployment 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