Skip to main content

Class: BatchJob

A link to a built-in batch job. Batch jobs can be used to perform operations on a set of workflows (e.g. terminate, signal, cancel, etc). This link can be put on workflow history events generated by actions taken by a batch job.

Properties​

jobId​

jobId: string

BatchJob jobId.

Methods​

toJSON()​

toJSON(): object

Converts this BatchJob to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchJob & $Properties

Creates a new BatchJob instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchJob & $Properties

BatchJob instance

Call Signature​

static create(properties?): BatchJob

Creates a new BatchJob instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchJob

BatchJob instance

decode()​

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

Decodes a BatchJob 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​

BatchJob & $Properties

BatchJob

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchJob & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchJob & $Properties

BatchJob

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 BatchJob message. Does not implicitly temporal.api.common.v1.Link.BatchJob.verify|verify messages.

Parameters​

message​

$Properties

BatchJob message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified BatchJob message, length delimited. Does not implicitly temporal.api.common.v1.Link.BatchJob.verify|verify messages.

Parameters​

message​

$Properties

BatchJob message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchJob

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

Parameters​

object​

Plain object

Returns​

BatchJob

BatchJob

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BatchJob

BatchJob

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object