Class: WorkflowMetadata
The name of the query to retrieve this information is __temporal_workflow_metadata
.
Implements
Constructors
constructor
• new WorkflowMetadata(properties?
): WorkflowMetadata
Constructs a new WorkflowMetadata.
Parameters
Name | Type | Description |
---|---|---|
properties? | IWorkflowMetadata | Properties to set |
Returns
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.
Implementation of
IWorkflowMetadata.currentDetails
definition
• Optional
definition: null
| IWorkflowDefinition
Metadata provided at declaration or creation time.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowMetadata to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): WorkflowMetadata
Creates a new WorkflowMetadata instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IWorkflowMetadata | Properties to set |
Returns
WorkflowMetadata instance
decode
▸ decode(reader
, length?
): WorkflowMetadata
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): WorkflowMetadata
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
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 | IWorkflowMetadata | 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 | IWorkflowMetadata | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for WorkflowMetadata
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 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