Class: Input
Represents an Input.
Implements
Constructors
constructor
• new Input(properties?): Input
Constructs a new Input.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInput | Properties to set |
Returns
Properties
args
• Optional args: null | IPayloads
The arguments to pass to the named handler.
Implementation of
header
• Optional header: null | IHeader
Headers that are passed with the update from the requesting entity. These can include things like auth or tracing tokens.
Implementation of
name
• name: string
The name of the input handler to invoke on the target workflow
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Input to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Input
Creates a new Input instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IInput | Properties to set |
Returns
Input instance
decode
▸ decode(reader, length?): Input
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
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 | IInput | 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 | IInput | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Input
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 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