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.
Implements
Constructors
constructor
• new Internal(properties?): Internal
Constructs a new Internal.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInternal | Properties to set |
Returns
Properties
data
• data: Uint8Array
Opaque internal data.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Internal to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Internal
Creates a new Internal instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInternal | Properties to set |
Returns
Internal instance
decode
▸ decode(reader, length?): Internal
Decodes an Internal message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Internal
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Internal
Decodes an Internal message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IInternal | Internal message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IInternal | Internal message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Internal
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Internal
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Internal message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Internal | Internal |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object