Skip to main content

Interface: IGetWorkflowExecutionHistoryRequest

workflowservice.v1.IGetWorkflowExecutionHistoryRequest

Properties of a GetWorkflowExecutionHistoryRequest.

Implemented by​

Properties​

execution​

• Optional execution: null | IWorkflowExecution

GetWorkflowExecutionHistoryRequest execution

historyEventFilterType​

• Optional historyEventFilterType: null | HistoryEventFilterType

Filter returned events such that they match the specified filter type. Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.

maximumPageSize​

• Optional maximumPageSize: null | number

GetWorkflowExecutionHistoryRequest maximumPageSize

namespace​

• Optional namespace: null | string

GetWorkflowExecutionHistoryRequest namespace

nextPageToken​

• Optional nextPageToken: null | Uint8Array

If a GetWorkflowExecutionHistoryResponse or a PollWorkflowTaskQueueResponse had one of these, it should be passed here to fetch the next page.

skipArchival​

• Optional skipArchival: null | boolean

GetWorkflowExecutionHistoryRequest skipArchival

waitNewEvent​

• Optional waitNewEvent: null | 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.