Class: PollActivityTaskQueueResponse
workflowservice.v1.PollActivityTaskQueueResponse
Represents a PollActivityTaskQueueResponse.
Implements
Constructors
constructor
• new PollActivityTaskQueueResponse(properties?): PollActivityTaskQueueResponse
Constructs a new PollActivityTaskQueueResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollActivityTaskQueueResponse | Properties to set |
Returns
Properties
activityId
• activityId: string
The autogenerated or user specified identifier of this activity. Can be used to complete the
activity via RespondActivityTaskCompletedById. May be re-used as long as the last usage
has resolved, but unique IDs for every activity invocation is a good idea.
Implementation of
IPollActivityTaskQueueResponse.activityId
activityType
• Optional activityType: null | IActivityType
PollActivityTaskQueueResponse activityType.
Implementation of
IPollActivityTaskQueueResponse.activityType
attempt
• attempt: number
Starting at 1, the number of attempts to perform this activity
Implementation of
IPollActivityTaskQueueResponse.attempt
currentAttemptScheduledTime
• Optional currentAttemptScheduledTime: null | ITimestamp
When was this task attempt scheduled
Implementation of
IPollActivityTaskQueueResponse.currentAttemptScheduledTime
header
• Optional header: null | IHeader
Headers specified by the scheduling workflow. Commonly used to propagate contextual info from the workflow to its activities. For example, tracing contexts.
Implementation of
IPollActivityTaskQueueResponse.header
heartbeatDetails
• Optional heartbeatDetails: null | IPayloads
Details of the last heartbeat that was recorded for this activity as of the time this task was delivered.
Implementation of
IPollActivityTaskQueueResponse.heartbeatDetails
heartbeatTimeout
• Optional heartbeatTimeout: null | IDuration
Window within which the activity must report a heartbeat, or be timed out.
Implementation of
IPollActivityTaskQueueResponse.heartbeatTimeout
input
• Optional input: null | IPayloads
Arguments to the activity invocation
Implementation of
IPollActivityTaskQueueResponse.input
retryPolicy
• Optional retryPolicy: null | IRetryPolicy
This is the retry policy the service uses which may be different from the one provided (or not) during activity scheduling. The service can override the provided one if some values are not specified or exceed configured system limits.
Implementation of
IPollActivityTaskQueueResponse.retryPolicy
scheduleToCloseTimeout
• Optional scheduleToCloseTimeout: null | IDuration
First scheduled -> final result reported timeout
(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
Implementation of
IPollActivityTaskQueueResponse.scheduleToCloseTimeout
scheduledTime
• Optional scheduledTime: null | ITimestamp
When was this task first scheduled
Implementation of
IPollActivityTaskQueueResponse.scheduledTime
startToCloseTimeout
• Optional startToCloseTimeout: null | IDuration
Current attempt start -> final result reported timeout
(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
Implementation of
IPollActivityTaskQueueResponse.startToCloseTimeout
startedTime
• Optional startedTime: null | ITimestamp
When was this task started (this attempt)
Implementation of
IPollActivityTaskQueueResponse.startedTime
taskToken
• taskToken: Uint8Array
A unique identifier for this task
Implementation of
IPollActivityTaskQueueResponse.taskToken
workflowExecution
• Optional workflowExecution: null | IWorkflowExecution
Execution info of the requesting workflow
Implementation of
IPollActivityTaskQueueResponse.workflowExecution
workflowNamespace
• workflowNamespace: string
The namespace the workflow which requested this activity lives in
Implementation of
IPollActivityTaskQueueResponse.workflowNamespace
workflowType
• Optional workflowType: null | IWorkflowType
Type of the requesting workflow
Implementation of
IPollActivityTaskQueueResponse.workflowType
Methods
toJSON
▸ toJSON(): Object
Converts this PollActivityTaskQueueResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollActivityTaskQueueResponse
Creates a new PollActivityTaskQueueResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollActivityTaskQueueResponse | Properties to set |
Returns
PollActivityTaskQueueResponse instance
decode
▸ decode(reader, length?): PollActivityTaskQueueResponse
Decodes a PollActivityTaskQueueResponse 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
PollActivityTaskQueueResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollActivityTaskQueueResponse
Decodes a PollActivityTaskQueueResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollActivityTaskQueueResponse
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 PollActivityTaskQueueResponse message. Does not implicitly temporal.api.workflowservice.v1.PollActivityTaskQueueResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollActivityTaskQueueResponse | PollActivityTaskQueueResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollActivityTaskQueueResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollActivityTaskQueueResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollActivityTaskQueueResponse | PollActivityTaskQueueResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollActivityTaskQueueResponse
Creates a PollActivityTaskQueueResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollActivityTaskQueueResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PollActivityTaskQueueResponse
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 PollActivityTaskQueueResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollActivityTaskQueueResponse | PollActivityTaskQueueResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object