Class: WorkflowInteractionDefinition
(-- api-linter: core::0123::resource-annotation=disabled
aip.dev/not-precedent: The name field is optional. --)
(-- api-linter: core::0203::optional=disabled --)
Properties
description
description:
string
An optional interaction description provided by the application. By convention, external tools may interpret its first part, i.e., ending with a line break, as a summary of the description.
name
name:
string
An optional name for the handler. If missing, it represents a dynamic handler that processes any interactions not handled by others. There is at most one dynamic handler per workflow and interaction kind.
Methods
toJSON()
toJSON():
object
Converts this WorkflowInteractionDefinition to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):WorkflowInteractionDefinition&$Properties
Creates a new WorkflowInteractionDefinition instance using the specified properties.
Parameters
properties?
Properties to set
Returns
WorkflowInteractionDefinition & $Properties
WorkflowInteractionDefinition instance
Call Signature
staticcreate(properties?):WorkflowInteractionDefinition
Creates a new WorkflowInteractionDefinition instance using the specified properties.
Parameters
properties?
Properties to set
Returns
WorkflowInteractionDefinition
WorkflowInteractionDefinition instance
decode()
staticdecode(reader,length?):WorkflowInteractionDefinition&$Properties
Decodes a WorkflowInteractionDefinition 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
WorkflowInteractionDefinition & $Properties
WorkflowInteractionDefinition
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):WorkflowInteractionDefinition&$Properties
Decodes a WorkflowInteractionDefinition message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
WorkflowInteractionDefinition & $Properties
WorkflowInteractionDefinition
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified WorkflowInteractionDefinition message. Does not implicitly temporal.api.sdk.v1.WorkflowInteractionDefinition.verify|verify messages.
Parameters
message
WorkflowInteractionDefinition message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified WorkflowInteractionDefinition message, length delimited. Does not implicitly temporal.api.sdk.v1.WorkflowInteractionDefinition.verify|verify messages.
Parameters
message
WorkflowInteractionDefinition message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):WorkflowInteractionDefinition
Creates a WorkflowInteractionDefinition message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
WorkflowInteractionDefinition
WorkflowInteractionDefinition
toObject()
statictoObject(message,options?):object
Creates a plain object from a WorkflowInteractionDefinition message. Also converts values to other types if specified.
Parameters
message
WorkflowInteractionDefinition
WorkflowInteractionDefinition
options?
IConversionOptions
Conversion options
Returns
object
Plain object