temporalio.client.WorkflowHistoryEventAsyncIterator

class documentation

class WorkflowHistoryEventAsyncIterator: (source)

Constructor: WorkflowHistoryEventAsyncIterator(client, input)

View In Hierarchy

Asynchronous iterator for history events of a workflow.

Most users should use async for on this iterator and not call any of the methods within.

Method __aiter__ Return self as the iterator.
Async Method __anext__ Get the next execution on this iterator, fetching next page if necessary.
Method __init__ Create an asynchronous iterator for the given input.
Async Method fetch_next_page Fetch the next page if any.
Property current_page Current page, if it has been fetched yet.
Property current_page_index Index of the entry in the current page that will be returned from the next __anext__ call.
Property next_page_token Token for the next page request if any.
Instance Variable _client Undocumented
Instance Variable _current_page Undocumented
Instance Variable _current_page_index Undocumented
Instance Variable _input Undocumented
Instance Variable _next_page_token Undocumented
def __aiter__(self) -> WorkflowHistoryEventAsyncIterator: (source)

Return self as the iterator.

async def __anext__(self) -> temporalio.api.history.v1.HistoryEvent: (source)

Get the next execution on this iterator, fetching next page if necessary.

def __init__(self, client: Client, input: FetchWorkflowHistoryEventsInput): (source)

Create an asynchronous iterator for the given input.

Users should not create this directly, but rather use WorkflowHandle.fetch_history_events.

async def fetch_next_page(self, *, page_size: Optional[int] = None): (source)

Fetch the next page if any.

Parameters
page_size:Optional[int]Override the page size this iterator was originally created with.
@property
current_page: Optional[Sequence[temporalio.api.history.v1.HistoryEvent]] = (source)

Current page, if it has been fetched yet.

@property
current_page_index: int = (source)

Index of the entry in the current page that will be returned from the next __anext__ call.

@property
next_page_token: Optional[bytes] = (source)

Token for the next page request if any.

_client = (source)

Undocumented

_current_page = (source)

Undocumented

_current_page_index: int = (source)

Undocumented

_input = (source)

Undocumented

_next_page_token = (source)

Undocumented