Class: WorkflowMetadata
The name of the query to retrieve this information is __temporal_workflow_metadata.
Properties
currentDetails
• currentDetails: string
Current long-form details of the workflow's state. This is used by user interfaces to show long-form text. This text may be formatted by the user interface.
definition
• Optional definition: null | $Properties
Metadata provided at declaration or creation time.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowMetadata to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowMetadata & $Properties
Creates a new WorkflowMetadata instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowMetadata & $Properties
WorkflowMetadata instance
▸ create(properties?): WorkflowMetadata
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowMetadata & $Properties
Decodes a WorkflowMetadata 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
WorkflowMetadata & $Properties
WorkflowMetadata
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowMetadata & $Properties
Decodes a WorkflowMetadata message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowMetadata & $Properties
WorkflowMetadata
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 WorkflowMetadata message. Does not implicitly temporal.api.sdk.v1.WorkflowMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowMetadata message, length delimited. Does not implicitly temporal.api.sdk.v1.WorkflowMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowMetadata
Creates a WorkflowMetadata message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowMetadata
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowMetadata message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowMetadata | WorkflowMetadata |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object