Struct SdkCommandDefinition 

pub struct SdkCommandDefinition {
    pub name: String,
    pub display_name: String,
    pub payload_template: String,
    pub description: String,
    pub parameters: Vec<SdkParameterDefinition>,
    pub fixed_values: HashMap<String, Value>,
    pub samples: Vec<Value>,
    pub parameter_groups: Vec<SdkParameterGroup>,
}

Command definition (SDK-specific)

Fields

name: String

Command name

display_name: String

Display name

payload_template: String

Payload template

description: String

Description

parameters: Vec<SdkParameterDefinition>

Parameters

fixed_values: HashMap<String, Value>

Fixed values

samples: Vec<Value>

Sample payloads

parameter_groups: Vec<SdkParameterGroup>

Parameter groups

Implementations

impl SdkCommandDefinition

pub fn new(name: impl Into<String>) -> Self

Create a new command definition

pub fn with_description(self, description: impl Into<String>) -> Self

Add description

pub fn param(self, param: SdkParameterDefinition) -> Self

Add a parameter

Trait Implementations

impl Clone for SdkCommandDefinition

fn clone(&self) -> SdkCommandDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SdkCommandDefinition

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

Formats the value using the given formatter.

impl Default for SdkCommandDefinition

fn default() -> SdkCommandDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SdkCommandDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SdkCommandDefinition> for CommandDescriptor

fn from(c: SdkCommandDefinition) -> Self

Converts to this type from the input type.

impl Serialize for SdkCommandDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.