Skip to main content

Class: BatchOperationInfo

Represents a BatchOperationInfo.

Properties​

closeTime?​

optional closeTime?: $Properties | null

Batch operation close time

jobId​

jobId: string

Batch job ID

operationType​

operationType: BatchOperationType

Operation type

startTime?​

optional startTime?: $Properties | null

Batch operation start time

state​

state: BatchOperationState

Batch operation state

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationInfo & $Properties

Creates a new BatchOperationInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationInfo & $Properties

BatchOperationInfo instance

Call Signature​

static create(properties?): BatchOperationInfo

Creates a new BatchOperationInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationInfo

BatchOperationInfo instance

decode()​

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

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

BatchOperationInfo & $Properties

BatchOperationInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationInfo & $Properties

BatchOperationInfo

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

Parameters​

message​

$Properties

BatchOperationInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BatchOperationInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationInfo

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

Parameters​

object​

Plain object

Returns​

BatchOperationInfo

BatchOperationInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BatchOperationInfo

BatchOperationInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object