Class: UpdateRef
The data needed by a client to refer to a previously invoked workflow execution update process.
Implements
Constructors
constructor
• new UpdateRef(properties?): UpdateRef
Constructs a new UpdateRef.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateRef | Properties to set |
Returns
Properties
updateId
• updateId: string
UpdateRef updateId.
Implementation of
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
UpdateRef workflowExecution.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateRef to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateRef
Creates a new UpdateRef instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateRef | Properties to set |
Returns
UpdateRef instance
decode
▸ decode(reader, length?): UpdateRef
Decodes an UpdateRef 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
UpdateRef
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateRef
Decodes an UpdateRef message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateRef
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 UpdateRef message. Does not implicitly temporal.api.update.v1.UpdateRef.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateRef | UpdateRef message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateRef message, length delimited. Does not implicitly temporal.api.update.v1.UpdateRef.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateRef | UpdateRef message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateRef
Creates an UpdateRef message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateRef
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateRef
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 UpdateRef message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateRef | UpdateRef |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object