Skip to main content

Class: Internal

v1.Callback.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

create(properties?): Internal & $Properties

Creates a new Internal instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

Internal & $Properties

Internal instance

create(properties?): Internal

Parameters

NameType
properties?$Properties

Returns

Internal


decode

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

Decodes an Internal message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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

decodeDelimited(reader): Internal & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader 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

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesInternal message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesInternal message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): Internal

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Internal

Internal


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageInternalInternal
options?IConversionOptionsConversion options

Returns

Object

Plain object