Class: ModifyWorkflowProperties
coresdk.workflow_commands.ModifyWorkflowProperties
Represents a ModifyWorkflowProperties.
Properties
upsertedMemo
• Optional upsertedMemo: null | $Properties
If set, update the workflow memo with the provided values. The values will be merged with the existing memo. If the user wants to delete values, a default/empty Payload should be used as the value for the key being deleted.
Methods
toJSON
▸ toJSON(): Object
Converts this ModifyWorkflowProperties to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ModifyWorkflowProperties & $Properties
Creates a new ModifyWorkflowProperties instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ModifyWorkflowProperties & $Properties
ModifyWorkflowProperties instance
▸ create(properties?): ModifyWorkflowProperties
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ModifyWorkflowProperties & $Properties
Decodes a ModifyWorkflowProperties 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
ModifyWorkflowProperties & $Properties
ModifyWorkflowProperties
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ModifyWorkflowProperties & $Properties
Decodes a ModifyWorkflowProperties message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ModifyWorkflowProperties & $Properties
ModifyWorkflowProperties
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 ModifyWorkflowProperties message. Does not implicitly coresdk.workflow_commands.ModifyWorkflowProperties.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ModifyWorkflowProperties message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ModifyWorkflowProperties message, length delimited. Does not implicitly coresdk.workflow_commands.ModifyWorkflowProperties.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ModifyWorkflowProperties message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ModifyWorkflowProperties
Creates a ModifyWorkflowProperties message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ModifyWorkflowProperties
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ModifyWorkflowProperties message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ModifyWorkflowProperties | ModifyWorkflowProperties |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object