Class: PinnedOverride

Represents a PinnedOverride.

Properties

behavior

behavior: PinnedOverrideBehavior

Defaults to PINNED_OVERRIDE_BEHAVIOR_UNSPECIFIED. See PinnedOverrideBehavior for details.

---

version?

optional version?: $Properties | null

Specifies the Worker Deployment Version to pin this workflow to. Required if the target workflow is not already pinned to a version.

If omitted and the target workflow is already pinned, the effective pinned version will be the existing pinned version.

If omitted and the target workflow is not pinned, the override request will be rejected with a PreconditionFailed error.

Methods

toJSON()

toJSON(): object

Converts this PinnedOverride to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): PinnedOverride & $Properties

Creates a new PinnedOverride instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PinnedOverride & $Properties

PinnedOverride instance

Call Signature

static create(properties?): PinnedOverride

Creates a new PinnedOverride instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PinnedOverride

PinnedOverride instance

---

decode()

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

Decodes a PinnedOverride 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

PinnedOverride & $Properties

PinnedOverride

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): PinnedOverride & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

PinnedOverride & $Properties

PinnedOverride

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 PinnedOverride message. Does not implicitly temporal.api.workflow.v1.VersioningOverride.PinnedOverride.verify|verify messages.

Parameters

message

$Properties

PinnedOverride message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified PinnedOverride message, length delimited. Does not implicitly temporal.api.workflow.v1.VersioningOverride.PinnedOverride.verify|verify messages.

Parameters

message

$Properties

PinnedOverride message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): PinnedOverride

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

Parameters

object

Plain object

Returns

PinnedOverride

PinnedOverride

---

toObject()

static toObject(message, options?): object

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

Parameters

message

PinnedOverride

PinnedOverride

options?

IConversionOptions

Conversion options

Returns

object

Plain object