Class: WorkflowTaskScheduledEventAttributes

Represents a WorkflowTaskScheduledEventAttributes.

Properties

attempt

attempt: number

Starting at 1, how many attempts there have been to complete this task

---

startToCloseTimeout?

optional startToCloseTimeout?: $Properties | null

How long the worker has to process this task once receiving it before it times out

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

---

taskQueue?

optional taskQueue?: $Properties | null

The task queue this workflow task was enqueued in, which could be a normal or sticky queue

Methods

toJSON()

toJSON(): object

Converts this WorkflowTaskScheduledEventAttributes to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): WorkflowTaskScheduledEventAttributes & $Properties

Creates a new WorkflowTaskScheduledEventAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WorkflowTaskScheduledEventAttributes & $Properties

WorkflowTaskScheduledEventAttributes instance

Call Signature

static create(properties?): WorkflowTaskScheduledEventAttributes

Creates a new WorkflowTaskScheduledEventAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WorkflowTaskScheduledEventAttributes

WorkflowTaskScheduledEventAttributes instance

---

decode()

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

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

WorkflowTaskScheduledEventAttributes & $Properties

WorkflowTaskScheduledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): WorkflowTaskScheduledEventAttributes & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

WorkflowTaskScheduledEventAttributes & $Properties

WorkflowTaskScheduledEventAttributes

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 WorkflowTaskScheduledEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowTaskScheduledEventAttributes.verify|verify messages.

Parameters

message

$Properties

WorkflowTaskScheduledEventAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowTaskScheduledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowTaskScheduledEventAttributes.verify|verify messages.

Parameters

message

$Properties

WorkflowTaskScheduledEventAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): WorkflowTaskScheduledEventAttributes

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

Parameters

object

Plain object

Returns

WorkflowTaskScheduledEventAttributes

WorkflowTaskScheduledEventAttributes

---

toObject()

static toObject(message, options?): object

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

Parameters

message

WorkflowTaskScheduledEventAttributes

WorkflowTaskScheduledEventAttributes

options?

IConversionOptions

Conversion options

Returns

object

Plain object