Skip to main content

Class: SetPatchMarker

coresdk.workflow_commands.SetPatchMarker

A request to set/check if a certain patch is present or not

Implements#

Constructors#

constructor#

new SetPatchMarker(properties?)

Constructs a new SetPatchMarker.

Parameters#

NameType
properties?ISetPatchMarker

Properties#

deprecated#

deprecated: boolean

SetPatchMarker deprecated.

Implementation of#

ISetPatchMarker.deprecated


patchId#

patchId: string

SetPatchMarker patchId.

Implementation of#

ISetPatchMarker.patchId

Methods#

toJSON#

toJSON(): Object

Converts this SetPatchMarker to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): SetPatchMarker

Decodes a SetPatchMarker message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

SetPatchMarker

SetPatchMarker


decodeDelimited#

Static decodeDelimited(reader): SetPatchMarker

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

SetPatchMarker

SetPatchMarker


encode#

Static encode(message, writer?): Writer

Encodes the specified SetPatchMarker message. Does not implicitly {@link coresdk.workflow_commands.SetPatchMarker.verify|verify} messages.

Parameters#

NameTypeDescription
messageISetPatchMarkerSetPatchMarker message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified SetPatchMarker message, length delimited. Does not implicitly {@link coresdk.workflow_commands.SetPatchMarker.verify|verify} messages.

Parameters#

NameTypeDescription
messageISetPatchMarkerSetPatchMarker message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): SetPatchMarker

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

SetPatchMarker

SetPatchMarker


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageSetPatchMarkerSetPatchMarker
options?IConversionOptions-

Returns#

Object

Plain object