pulp::inspect::ControlTimelineDocumentSessionOutcome Struct Reference

One typed outcome from the bound timeline::DocumentSession. More...

#include <control_timeline_document_session_executor.hpp>

Public Attributes
bool	accepted = false
	True when the session accepted the request.
std::string	session_id
	Session identity. Required on every accepted outcome.
std::uint64_t	revision = 0
	Published document revision after the request.
bool	applied = false
	True when the session committed a new revision.
bool	replayed = false
	True when an identical idempotency_key replayed a cached result.
std::string	diff_json
	Change-set payload for Diff, empty otherwise.
std::optional< pulp::timeline::ConflictCode >	conflict
	The session's refusal cause. Required on every refused outcome.
std::string	refusal_json
	The offline surface's typed refusal envelope, verbatim.
std::string	explanation
	Human-readable account of the refusal.

Detailed Description

One typed outcome from the bound timeline::DocumentSession.

A refusal carries the session's own ConflictCode rather than a broker-side re-interpretation, so the live surface and the offline surface refuse the same case under the same name.

Member Data Documentation

accepted

bool pulp::inspect::ControlTimelineDocumentSessionOutcome::accepted = false

True when the session accepted the request.

applied

bool pulp::inspect::ControlTimelineDocumentSessionOutcome::applied = false

True when the session committed a new revision.

conflict

std::optional<pulp::timeline::ConflictCode> pulp::inspect::ControlTimelineDocumentSessionOutcome::conflict

The session's refusal cause. Required on every refused outcome.

diff_json

std::string pulp::inspect::ControlTimelineDocumentSessionOutcome::diff_json

Change-set payload for Diff, empty otherwise.

explanation

std::string pulp::inspect::ControlTimelineDocumentSessionOutcome::explanation

Human-readable account of the refusal.

refusal_json

std::string pulp::inspect::ControlTimelineDocumentSessionOutcome::refusal_json

The offline surface's typed refusal envelope, verbatim.

replayed

bool pulp::inspect::ControlTimelineDocumentSessionOutcome::replayed = false

True when an identical idempotency_key replayed a cached result.

revision

std::uint64_t pulp::inspect::ControlTimelineDocumentSessionOutcome::revision = 0

Published document revision after the request.

session_id

std::string pulp::inspect::ControlTimelineDocumentSessionOutcome::session_id

Session identity. Required on every accepted outcome.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/pulp/pulp/inspect/include/pulp/inspect/control_timeline_document_session_executor.hpp