Skip to main content

Interface: IGetWorkflowExecutionHistoryRequest

Properties of a GetWorkflowExecutionHistoryRequest.

Extends​

Properties​

execution?​

optional execution?: $Properties | null

GetWorkflowExecutionHistoryRequest execution

Inherited from​

$Properties.execution


historyEventFilterType?​

optional historyEventFilterType?: HistoryEventFilterType | null

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

Inherited from​

$Properties.historyEventFilterType


maximumPageSize?​

optional maximumPageSize?: number | null

GetWorkflowExecutionHistoryRequest maximumPageSize

Inherited from​

$Properties.maximumPageSize


namespace?​

optional namespace?: string | null

GetWorkflowExecutionHistoryRequest namespace

Inherited from​

$Properties.namespace


nextPageToken?​

optional nextPageToken?: Uint8Array<ArrayBufferLike> | null

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

Inherited from​

$Properties.nextPageToken


skipArchival?​

optional skipArchival?: boolean | null

GetWorkflowExecutionHistoryRequest skipArchival

Inherited from​

$Properties.skipArchival


waitNewEvent?​

optional waitNewEvent?: boolean | null

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.

Inherited from​

$Properties.waitNewEvent