Skip to main content

Class: RequestIdInfo

RequestIdInfo contains details of a request ID.

Properties​

buffered​

buffered: boolean

Indicate if the request is still buffered. If so, the event ID is not known and its value will be an invalid event ID.

eventId​

eventId: Long

The event id of the history event generated by the request. It's possible the event ID is not known (unflushed buffered event). In this case, the value will be zero or a negative value, representing an invalid ID.

eventType​

eventType: EventType

The event type of the history event generated by the request.

Methods​

toJSON()​

toJSON(): object

Converts this RequestIdInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): RequestIdInfo & $Properties

Creates a new RequestIdInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestIdInfo & $Properties

RequestIdInfo instance

Call Signature​

static create(properties?): RequestIdInfo

Creates a new RequestIdInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

RequestIdInfo

RequestIdInfo instance

decode()​

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

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

RequestIdInfo & $Properties

RequestIdInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): RequestIdInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

RequestIdInfo & $Properties

RequestIdInfo

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

Parameters​

message​

$Properties

RequestIdInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

RequestIdInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): RequestIdInfo

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

Parameters​

object​

Plain object

Returns​

RequestIdInfo

RequestIdInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

RequestIdInfo

RequestIdInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object