Skip to main content

Class: ScheduleActivity

coresdk.workflow_commands.ScheduleActivity

Represents a ScheduleActivity.

Implements#

Constructors#

constructor#

new ScheduleActivity(properties?)

Constructs a new ScheduleActivity.

Parameters#

NameType
properties?IScheduleActivity

Properties#

activityId#

activityId: string

ScheduleActivity activityId.

Implementation of#

IScheduleActivity.activityId


activityType#

activityType: string

ScheduleActivity activityType.

Implementation of#

IScheduleActivity.activityType


arguments#

arguments: IPayload[]

Arguments/input to the activity. Called "input" upstream.

Implementation of#

IScheduleActivity.arguments


cancellationType#

cancellationType: ActivityCancellationType

Defines behaviour of the underlying workflow when activity cancellation has been requested.

Implementation of#

IScheduleActivity.cancellationType


headerFields#

headerFields: Object

ScheduleActivity headerFields.

Index signature#

▪ [k: string]: IPayload

Implementation of#

IScheduleActivity.headerFields


heartbeatTimeout#

Optional heartbeatTimeout: null | IDuration

Maximum time allowed between successful worker heartbeats.

Implementation of#

IScheduleActivity.heartbeatTimeout


namespace#

namespace: string

ScheduleActivity namespace.

Implementation of#

IScheduleActivity.namespace


retryPolicy#

Optional retryPolicy: null | IRetryPolicy

retry_policy.maximum_attempts to 2.

Implementation of#

IScheduleActivity.retryPolicy


scheduleToCloseTimeout#

Optional scheduleToCloseTimeout: null | IDuration

When not specified defaults to the workflow execution timeout.

Implementation of#

IScheduleActivity.scheduleToCloseTimeout


scheduleToStartTimeout#

Optional scheduleToStartTimeout: null | IDuration

queue. Defaults to schedule_to_close_timeout or workflow execution timeout if not specified.

Implementation of#

IScheduleActivity.scheduleToStartTimeout


seq#

seq: number

Lang's incremental sequence number, used as the operation identifier

Implementation of#

IScheduleActivity.seq


startToCloseTimeout#

Optional startToCloseTimeout: null | IDuration

always retryable. Either this or schedule_to_close_timeout must be specified.

Implementation of#

IScheduleActivity.startToCloseTimeout


taskQueue#

taskQueue: string

ScheduleActivity taskQueue.

Implementation of#

IScheduleActivity.taskQueue

Methods#

toJSON#

toJSON(): Object

Converts this ScheduleActivity to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ScheduleActivity

Decodes a ScheduleActivity 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#

ScheduleActivity

ScheduleActivity


decodeDelimited#

Static decodeDelimited(reader): ScheduleActivity

Decodes a ScheduleActivity 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#

ScheduleActivity

ScheduleActivity


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ScheduleActivity

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ScheduleActivity

ScheduleActivity


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageScheduleActivityScheduleActivity
options?IConversionOptions-

Returns#

Object

Plain object