Struct RuntimeStatusDetails 

pub struct RuntimeStatusDetails {
    pub reason: Option<String>,
    pub connector_stats: Option<ConnectorStats>,
    pub approval_diff: Option<Value>,
}

Details about the current runtime status. The fields in this struct should all be optional and set only by a runtime status when they are known. Otherwise, they can just be set None.

Fields

reason: Option<String>

Free form text giving an explanation why it is currently in this runtime status.

Specifically useful for: Unavailable, Initializing.

connector_stats: Option<ConnectorStats>

Statistics across all connectors.

Specifically useful for: Paused, Running.

approval_diff: Option<Value>

The diff which is awaiting approval.

Specifically useful for: AwaitingApproval.

Implementations

impl RuntimeStatusDetails

pub fn new_only_reason(reason: &str) -> Self

pub fn serialize_guaranteed(self) -> Value

Serializes the runtime status details to JSON. If the serialization errors, an error JSON is returned instead. This makes sure this method does not panic unexpectedly and that the error bubbles up. The details are only supplementary information, and as such are not critical to operation.

Trait Implementations

impl Clone for RuntimeStatusDetails

fn clone(&self) -> RuntimeStatusDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeStatusDetails

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

Formats the value using the given formatter.

impl Default for RuntimeStatusDetails

fn default() -> RuntimeStatusDetails

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RuntimeStatusDetails

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RuntimeStatusDetails

impl PartialEq for RuntimeStatusDetails

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for RuntimeStatusDetails

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RuntimeStatusDetails

impl<'__s> ToSchema<'__s> for RuntimeStatusDetails

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.