Skip to main content

Interface: $Properties

Properties of a GetWorkflowExecutionHistoryRequest.

Extended by​

Properties​

execution?​

optional execution?: $Properties | null

GetWorkflowExecutionHistoryRequest execution

historyEventFilterType?​

optional historyEventFilterType?: HistoryEventFilterType | null

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

maximumPageSize?​

optional maximumPageSize?: number | null

GetWorkflowExecutionHistoryRequest maximumPageSize

namespace?​

optional namespace?: string | null

GetWorkflowExecutionHistoryRequest 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.

skipArchival?​

optional skipArchival?: boolean | null

GetWorkflowExecutionHistoryRequest 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.