Class: WorkflowPropertiesModifiedExternallyEventAttributes
history.v1.WorkflowPropertiesModifiedExternallyEventAttributes
Represents a WorkflowPropertiesModifiedExternallyEventAttributes.
Implements
Constructors
constructor
• new WorkflowPropertiesModifiedExternallyEventAttributes(properties?): WorkflowPropertiesModifiedExternallyEventAttributes
Constructs a new WorkflowPropertiesModifiedExternallyEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowPropertiesModifiedExternallyEventAttributes | Properties to set |
Returns
WorkflowPropertiesModifiedExternallyEventAttributes
Properties
newTaskQueue
• newTaskQueue: string
If set to a nonempty string, future workflow tasks for this workflow shall be dispatched on the provided queue.
Implementation of
IWorkflowPropertiesModifiedExternallyEventAttributes.newTaskQueue
newWorkflowExecutionTimeout
• Optional newWorkflowExecutionTimeout: null | IDuration
If set, update the workflow execution timeout to this value. May be set to 0 for no timeout.
Implementation of
IWorkflowPropertiesModifiedExternallyEventAttributes.newWorkflowExecutionTimeout
newWorkflowRunTimeout
• Optional newWorkflowRunTimeout: null | IDuration
If set, update the workflow run timeout to this value. May be set to 0 for no timeout.
Implementation of
IWorkflowPropertiesModifiedExternallyEventAttributes.newWorkflowRunTimeout
newWorkflowTaskTimeout
• Optional newWorkflowTaskTimeout: null | IDuration
If set, update the workflow task timeout to this value.
Implementation of
IWorkflowPropertiesModifiedExternallyEventAttributes.newWorkflowTaskTimeout
upsertedMemo
• Optional upsertedMemo: null | IMemo
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.
Implementation of
IWorkflowPropertiesModifiedExternallyEventAttributes.upsertedMemo
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowPropertiesModifiedExternallyEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowPropertiesModifiedExternallyEventAttributes
Creates a new WorkflowPropertiesModifiedExternallyEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowPropertiesModifiedExternallyEventAttributes | Properties to set |
Returns
WorkflowPropertiesModifiedExternallyEventAttributes
WorkflowPropertiesModifiedExternallyEventAttributes instance
decode
▸ decode(reader, length?): WorkflowPropertiesModifiedExternallyEventAttributes
Decodes a WorkflowPropertiesModifiedExternallyEventAttributes 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
WorkflowPropertiesModifiedExternallyEventAttributes
WorkflowPropertiesModifiedExternallyEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowPropertiesModifiedExternallyEventAttributes
Decodes a WorkflowPropertiesModifiedExternallyEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowPropertiesModifiedExternallyEventAttributes
WorkflowPropertiesModifiedExternallyEventAttributes
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 WorkflowPropertiesModifiedExternallyEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowPropertiesModifiedExternallyEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowPropertiesModifiedExternallyEventAttributes | WorkflowPropertiesModifiedExternallyEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowPropertiesModifiedExternallyEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowPropertiesModifiedExternallyEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowPropertiesModifiedExternallyEventAttributes | WorkflowPropertiesModifiedExternallyEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowPropertiesModifiedExternallyEventAttributes
Creates a WorkflowPropertiesModifiedExternallyEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowPropertiesModifiedExternallyEventAttributes
WorkflowPropertiesModifiedExternallyEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowPropertiesModifiedExternallyEventAttributes
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 WorkflowPropertiesModifiedExternallyEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowPropertiesModifiedExternallyEventAttributes | WorkflowPropertiesModifiedExternallyEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object