Class: PollWorkflowExecutionUpdateRequest
workflowservice.v1.PollWorkflowExecutionUpdateRequest
Represents a PollWorkflowExecutionUpdateRequest.
Implements
Constructors
constructor
• new PollWorkflowExecutionUpdateRequest(properties?): PollWorkflowExecutionUpdateRequest
Constructs a new PollWorkflowExecutionUpdateRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollWorkflowExecutionUpdateRequest | Properties to set |
Returns
PollWorkflowExecutionUpdateRequest
Properties
identity
• identity: string
The identity of the worker/client who is polling this update outcome
Implementation of
IPollWorkflowExecutionUpdateRequest.identity
namespace
• namespace: string
The namespace of the workflow execution to which the update was originally issued.
Implementation of
IPollWorkflowExecutionUpdateRequest.namespace
updateRef
• Optional updateRef: null | IUpdateRef
The update reference returned in the initial UpdateWorkflowExecutionResponse
Implementation of
IPollWorkflowExecutionUpdateRequest.updateRef
waitPolicy
• Optional waitPolicy: null | IWaitPolicy
Describes when this poll request should return a response. Omit to request a non-blocking poll.
Implementation of
IPollWorkflowExecutionUpdateRequest.waitPolicy
Methods
toJSON
▸ toJSON(): Object
Converts this PollWorkflowExecutionUpdateRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollWorkflowExecutionUpdateRequest
Creates a new PollWorkflowExecutionUpdateRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollWorkflowExecutionUpdateRequest | Properties to set |
Returns
PollWorkflowExecutionUpdateRequest
PollWorkflowExecutionUpdateRequest instance
decode
▸ decode(reader, length?): PollWorkflowExecutionUpdateRequest
Decodes a PollWorkflowExecutionUpdateRequest 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
PollWorkflowExecutionUpdateRequest
PollWorkflowExecutionUpdateRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollWorkflowExecutionUpdateRequest
Decodes a PollWorkflowExecutionUpdateRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollWorkflowExecutionUpdateRequest
PollWorkflowExecutionUpdateRequest
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 PollWorkflowExecutionUpdateRequest message. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionUpdateRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollWorkflowExecutionUpdateRequest | PollWorkflowExecutionUpdateRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollWorkflowExecutionUpdateRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionUpdateRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollWorkflowExecutionUpdateRequest | PollWorkflowExecutionUpdateRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollWorkflowExecutionUpdateRequest
Creates a PollWorkflowExecutionUpdateRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollWorkflowExecutionUpdateRequest
PollWorkflowExecutionUpdateRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PollWorkflowExecutionUpdateRequest
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 PollWorkflowExecutionUpdateRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollWorkflowExecutionUpdateRequest | PollWorkflowExecutionUpdateRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object