Class: GetWorkflowExecutionHistoryRequest
workflowservice.v1.GetWorkflowExecutionHistoryRequest
Represents a GetWorkflowExecutionHistoryRequest.
Implements
Constructors
constructor
• new GetWorkflowExecutionHistoryRequest(properties?): GetWorkflowExecutionHistoryRequest
Constructs a new GetWorkflowExecutionHistoryRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetWorkflowExecutionHistoryRequest | Properties to set |
Returns
GetWorkflowExecutionHistoryRequest
Properties
execution
• Optional execution: null | IWorkflowExecution
GetWorkflowExecutionHistoryRequest execution.
Implementation of
IGetWorkflowExecutionHistoryRequest.execution
historyEventFilterType
• historyEventFilterType: HistoryEventFilterType
Filter returned events such that they match the specified filter type. Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.
Implementation of
IGetWorkflowExecutionHistoryRequest.historyEventFilterType
maximumPageSize
• maximumPageSize: number
GetWorkflowExecutionHistoryRequest maximumPageSize.
Implementation of
IGetWorkflowExecutionHistoryRequest.maximumPageSize
namespace
• namespace: string
GetWorkflowExecutionHistoryRequest namespace.
Implementation of
IGetWorkflowExecutionHistoryRequest.namespace
nextPageToken
• nextPageToken: Uint8Array
If a GetWorkflowExecutionHistoryResponse or a PollWorkflowTaskQueueResponse had one of
these, it should be passed here to fetch the next page.
Implementation of
IGetWorkflowExecutionHistoryRequest.nextPageToken
skipArchival
• skipArchival: boolean
GetWorkflowExecutionHistoryRequest skipArchival.
Implementation of
IGetWorkflowExecutionHistoryRequest.skipArchival
waitNewEvent
• waitNewEvent: boolean
If set to true, the RPC call will not resolve until there is a new event which matches
the history_event_filter_type, or a timeout is hit.
Implementation of
IGetWorkflowExecutionHistoryRequest.waitNewEvent
Methods
toJSON
▸ toJSON(): Object
Converts this GetWorkflowExecutionHistoryRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): GetWorkflowExecutionHistoryRequest
Creates a new GetWorkflowExecutionHistoryRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IGetWorkflowExecutionHistoryRequest | Properties to set |
Returns
GetWorkflowExecutionHistoryRequest
GetWorkflowExecutionHistoryRequest instance
decode
▸ decode(reader, length?): GetWorkflowExecutionHistoryRequest
Decodes a GetWorkflowExecutionHistoryRequest 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
GetWorkflowExecutionHistoryRequest
GetWorkflowExecutionHistoryRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): GetWorkflowExecutionHistoryRequest
Decodes a GetWorkflowExecutionHistoryRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
GetWorkflowExecutionHistoryRequest
GetWorkflowExecutionHistoryRequest
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 GetWorkflowExecutionHistoryRequest message. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetWorkflowExecutionHistoryRequest | GetWorkflowExecutionHistoryRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified GetWorkflowExecutionHistoryRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.GetWorkflowExecutionHistoryRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IGetWorkflowExecutionHistoryRequest | GetWorkflowExecutionHistoryRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): GetWorkflowExecutionHistoryRequest
Creates a GetWorkflowExecutionHistoryRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
GetWorkflowExecutionHistoryRequest
GetWorkflowExecutionHistoryRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for GetWorkflowExecutionHistoryRequest
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 GetWorkflowExecutionHistoryRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | GetWorkflowExecutionHistoryRequest | GetWorkflowExecutionHistoryRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object