Skip to main content

Class: Internal

Callbacks to be delivered internally within the system. This variant is not settable in the API and will be rejected by the service with an INVALID_ARGUMENT error. The only reason that this is exposed is because callbacks are replicated across clusters via the WorkflowExecutionStarted event, which is defined in the public API.

Properties​

data​

data: Uint8Array

Opaque internal data.

Methods​

toJSON()​

toJSON(): object

Converts this Internal to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Internal & $Properties

Creates a new Internal instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Internal & $Properties

Internal instance

Call Signature​

static create(properties?): Internal

Creates a new Internal instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Internal

Internal instance

decode()​

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

Decodes an Internal 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​

Internal & $Properties

Internal

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Internal & $Properties

Decodes an Internal message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Internal & $Properties

Internal

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

Parameters​

message​

$Properties

Internal message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Internal message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Internal

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Internal

Internal

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Internal

Internal

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object