Class: PollActivityExecutionRequest
workflowservice.v1.PollActivityExecutionRequest
Represents a PollActivityExecutionRequest.
Implements
Constructors
constructor
• new PollActivityExecutionRequest(properties?): PollActivityExecutionRequest
Constructs a new PollActivityExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollActivityExecutionRequest | Properties to set |
Returns
Properties
activityId
• activityId: string
PollActivityExecutionRequest activityId.
Implementation of
IPollActivityExecutionRequest.activityId
namespace
• namespace: string
PollActivityExecutionRequest namespace.
Implementation of
IPollActivityExecutionRequest.namespace
runId
• runId: string
Activity run ID. If empty the request targets the latest run.
Implementation of
IPollActivityExecutionRequest.runId
Methods
toJSON
▸ toJSON(): Object
Converts this PollActivityExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollActivityExecutionRequest
Creates a new PollActivityExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollActivityExecutionRequest | Properties to set |
Returns
PollActivityExecutionRequest instance
decode
▸ decode(reader, length?): PollActivityExecutionRequest
Decodes a PollActivityExecutionRequest 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
PollActivityExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollActivityExecutionRequest
Decodes a PollActivityExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollActivityExecutionRequest
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 PollActivityExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.PollActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollActivityExecutionRequest | PollActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollActivityExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollActivityExecutionRequest | PollActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollActivityExecutionRequest
Creates a PollActivityExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollActivityExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PollActivityExecutionRequest
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 PollActivityExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollActivityExecutionRequest | PollActivityExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object