Struct AddIndicatorRequest 

pub struct AddIndicatorRequest {
    pub objective_id: String,
    pub name: String,
    pub unit: String,
    pub direction: i32,
    pub frequency: i32,
    pub owner_user_id: String,
    pub evidence_source: Option<EvidenceSource>,
    pub rationale: String,
    pub strategic_meaning: String,
    pub interpretation_guidance: String,
    pub perverse_behavior_note: String,
    pub target: Option<f64>,
}

Request to attach an indicator to an objective.

Fields

objective_id: String

Objective the indicator hangs from. Required.

name: String

Short name. Required. Constraints: Max length 200 characters.

unit: String

Unit the readings are expressed in. Optional. Constraints: Max length 50 characters.

direction: i32

Desired direction of movement.

frequency: i32

Expected reading cadence.

owner_user_id: String

Accountable user. Optional.

evidence_source: Option<EvidenceSource>

Where readings come from. Required.

rationale: String

Why this indicator was chosen. Optional. Constraints: Max length 2000 characters.

strategic_meaning: String

What it is meant to say about the objective. Optional. Constraints: Max length 2000 characters.

interpretation_guidance: String

How a reading should be read. Optional. Constraints: Max length 2000 characters.

perverse_behavior_note: String

Behaviour the indicator could encourage if optimized on its own. Optional; the server pre-fills it when left empty and the evidence source implies one. Constraints: Max length 2000 characters.

target: Option<f64>

The value being aimed for, expressed in unit. Optional.

Implementations

impl AddIndicatorRequest

pub fn direction(&self) -> IndicatorDirection

Returns the enum value of direction, or the default if the field is set to an invalid enum value.

pub fn set_direction(&mut self, value: IndicatorDirection)

Sets direction to the provided enum value.

pub fn frequency(&self) -> IndicatorFrequency

Returns the enum value of frequency, or the default if the field is set to an invalid enum value.

pub fn set_frequency(&mut self, value: IndicatorFrequency)

Sets frequency to the provided enum value.

pub fn target(&self) -> f64

Returns the value of target, or the default value if target is unset.

Trait Implementations

impl Clone for AddIndicatorRequest

fn clone(&self) -> AddIndicatorRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddIndicatorRequest

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

Formats the value using the given formatter.

impl Default for AddIndicatorRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for AddIndicatorRequest

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 AddIndicatorRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AddIndicatorRequest