Class: WorkflowTaskScheduledEventAttributes
history.v1.WorkflowTaskScheduledEventAttributes
Represents a WorkflowTaskScheduledEventAttributes.
Implements
Constructors
constructor
• new WorkflowTaskScheduledEventAttributes(properties?): WorkflowTaskScheduledEventAttributes
Constructs a new WorkflowTaskScheduledEventAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowTaskScheduledEventAttributes | Properties to set |
Returns
WorkflowTaskScheduledEventAttributes
Properties
attempt
• attempt: number
Starting at 1, how many attempts there have been to complete this task
Implementation of
IWorkflowTaskScheduledEventAttributes.attempt
startToCloseTimeout
• Optional startToCloseTimeout: null | IDuration
How long the worker has to process this task once receiving it before it times out
(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
Implementation of
IWorkflowTaskScheduledEventAttributes.startToCloseTimeout
taskQueue
• Optional taskQueue: null | ITaskQueue
The task queue this workflow task was enqueued in, which could be a normal or sticky queue
Implementation of
IWorkflowTaskScheduledEventAttributes.taskQueue
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowTaskScheduledEventAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowTaskScheduledEventAttributes
Creates a new WorkflowTaskScheduledEventAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowTaskScheduledEventAttributes | Properties to set |
Returns
WorkflowTaskScheduledEventAttributes
WorkflowTaskScheduledEventAttributes instance
decode
▸ decode(reader, length?): WorkflowTaskScheduledEventAttributes
Decodes a WorkflowTaskScheduledEventAttributes 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
WorkflowTaskScheduledEventAttributes
WorkflowTaskScheduledEventAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowTaskScheduledEventAttributes
Decodes a WorkflowTaskScheduledEventAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowTaskScheduledEventAttributes
WorkflowTaskScheduledEventAttributes
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 WorkflowTaskScheduledEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowTaskScheduledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowTaskScheduledEventAttributes | WorkflowTaskScheduledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowTaskScheduledEventAttributes message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowTaskScheduledEventAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowTaskScheduledEventAttributes | WorkflowTaskScheduledEventAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowTaskScheduledEventAttributes
Creates a WorkflowTaskScheduledEventAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowTaskScheduledEventAttributes
WorkflowTaskScheduledEventAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowTaskScheduledEventAttributes
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 WorkflowTaskScheduledEventAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowTaskScheduledEventAttributes | WorkflowTaskScheduledEventAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object