Skip to main content

Class: SetPatchMarker

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

Properties​

deprecated​

deprecated: boolean

Can be set to true to indicate that branches using this change are being removed, and all future worker deployments will only have the "with change" code in them.

patchId​

patchId: string

A user-chosen identifier for this patch. If the same identifier is used in multiple places in the code, those places are considered to be versioned as one unit. IE: The check call will return the same result for all of them

Methods​

toJSON()​

toJSON(): object

Converts this SetPatchMarker to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SetPatchMarker & $Properties

Creates a new SetPatchMarker instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SetPatchMarker & $Properties

SetPatchMarker instance

Call Signature​

static create(properties?): SetPatchMarker

Creates a new SetPatchMarker instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SetPatchMarker

SetPatchMarker instance

decode()​

static decode(reader, length?): SetPatchMarker & $Properties

Decodes a SetPatchMarker message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

SetPatchMarker & $Properties

SetPatchMarker

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SetPatchMarker & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SetPatchMarker & $Properties

SetPatchMarker

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified SetPatchMarker message. Does not implicitly coresdk.workflow_commands.SetPatchMarker.verify|verify messages.

Parameters​

message​

$Properties

SetPatchMarker message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SetPatchMarker message or plain object to encode

writer?​

Writer

Writer to encode to

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​

object​

{[k: string]: any; }

Plain 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​

message​

SetPatchMarker

SetPatchMarker

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object