Class: Meta
Metadata about a workflow execution update.
Implements
Constructors
constructor
• new Meta(properties?): Meta
Constructs a new Meta.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMeta | Properties to set |
Returns
Properties
identity
• identity: string
A string identifying the agent that requested this update.
Implementation of
updateId
• updateId: string
An ID with workflow-scoped uniqueness for this update
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Meta to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Meta
Creates a new Meta instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IMeta | Properties to set |
Returns
Meta instance
decode
▸ decode(reader, length?): Meta
Decodes a Meta 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
Meta
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Meta
Decodes a Meta message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Meta
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 Meta message. Does not implicitly temporal.api.update.v1.Meta.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMeta | Meta message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Meta message, length delimited. Does not implicitly temporal.api.update.v1.Meta.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IMeta | Meta message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Meta
Creates a Meta message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Meta
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Meta
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 Meta message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Meta | Meta |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object