Struct IntentDescriptor 

#[non_exhaustive]
pub struct IntentDescriptor {
    pub description: Option<String>,
    pub intent: String,
    pub params: Option<BTreeMap>,
    pub semantics: Vec<String>,
}

One restore purpose a consumer advertises support for: the behaviours it opts into and the settings it accepts per replica.

JSON schema

{
 "description": "One restore purpose a consumer advertises support for: the behaviours it\nopts into and the settings it accepts per replica.",
 "type": "object",
 "required": [
   "intent"
 ],
 "properties": {
   "description": {
     "description": "Human-readable description of the intent, if provided.",
     "type": [
       "string",
       "null"
     ]
   },
   "intent": {
     "description": "Name of the intent: an arbitrary identifier chosen by the consumer\n(e.g. `verify`); any name may be advertised.",
     "type": "string"
   },
   "params": {
     "description": "Configurable parameters this intent accepts per replica, keyed by\nparameter name.",
     "$ref": "#/components/schemas/BTreeMap"
   },
   "semantics": {
     "description": "Behaviours this intent opts into. Recognised values are `check` (a\nhealth report is expected for each replica), `once` (a given snapshot\nis only ever dispatched to a replica once, rather than repeatedly\nuntil overdue), and `url` (a replica's health report includes a link\nto it). Unrecognised values are stored but have no effect.",
     "type": "array",
     "items": {
       "type": "string"
     }
   }
 }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Option<String>

Human-readable description of the intent, if provided.

intent: String

Name of the intent: an arbitrary identifier chosen by the consumer (e.g. verify); any name may be advertised.

params: Option<BTreeMap>

Configurable parameters this intent accepts per replica, keyed by parameter name.

semantics: Vec<String>

Behaviours this intent opts into. Recognised values are check (a health report is expected for each replica), once (a given snapshot is only ever dispatched to a replica once, rather than repeatedly until overdue), and url (a replica’s health report includes a link to it). Unrecognised values are stored but have no effect.

Implementations

impl IntentDescriptor

pub fn builder() -> IntentDescriptorBuilder

Create an instance of IntentDescriptor using the builder syntax

Trait Implementations

impl Clone for IntentDescriptor

fn clone(&self) -> IntentDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntentDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IntentDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IntentDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.