Struct GetHistoryEventsResponse 

pub struct GetHistoryEventsResponse {
    pub events: Vec<FlowHistoryEvent>,
    pub next_page_token: Vec<u8>,
    pub next_internal_event_id: i64,
    pub pruned_event_id_range: Option<HistoryEventIdRange>,
}

Fields

events: Vec<FlowHistoryEvent>

next_page_token: Vec<u8>

next_internal_event_id: i64

pruned_event_id_range: Option<HistoryEventIdRange>

The event IDs that the history window removed from this run, as of this response.

The Server keeps a recent window of each run’s history. It always keeps the FlowStartedOrContinued event, which is event 1, and it removes older events after it in chunks. The range therefore starts at event ID 2. Every event whose ID is inside this inclusive range is gone. No page and no run attempt returns it again. The range only grows while the run records new events.

Use the range to classify a related event ID, such as StepMethodEventContext.from_event_id or StepMethodEventContext.wait_for_completed_event_id. An ID inside the range names a removed event. An ID outside the range was not removed as of this response. Such an ID can still name an event outside the run attempt lineage that GetHistoryEventsRequest.run_attempt selects, or an event the run has not recorded yet. The related IDs that Step method events carry always name events of their own lineage.

Event IDs grow across the whole run, and removal follows that order, so the removed IDs form one range. The range is the same on every page and for every run attempt of the run. It can include IDs of events that belong only to other run attempts.

Unset when the history window has removed no event. Also unset from a Server that does not report removed events.

Trait Implementations

impl Clone for GetHistoryEventsResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetHistoryEventsResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetHistoryEventsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for GetHistoryEventsResponse

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for GetHistoryEventsResponse

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GetHistoryEventsResponse