Class: Input
Represents an Input.
Properties
args
• Optional args: null | $Properties
The arguments to pass to the named Update handler.
header
• Optional header: null | $Properties
Headers that are passed with the Update from the requesting entity. These can include things like auth or tracing tokens.
name
• name: string
The name of the Update handler to invoke on the target Workflow.
Methods
toJSON
▸ toJSON(): Object
Converts this Input to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Input & $Properties
Creates a new Input instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Input instance
▸ create(properties?): Input
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Input & $Properties
Decodes an Input 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
Input
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Input & $Properties
Decodes an Input message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Input
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 Input message. Does not implicitly temporal.api.update.v1.Input.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Input message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Input message, length delimited. Does not implicitly temporal.api.update.v1.Input.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Input message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Input
Creates an Input message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Input
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Input message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Input | Input |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object