Struct chirpstack_api::as_pb::external::api::ServiceProfile

pub struct ServiceProfile {

    pub id: String,
    pub name: String,
    pub organization_id: i64,
    pub network_server_id: i64,
    pub ul_rate: u32,
    pub ul_bucket_size: u32,
    pub ul_rate_policy: i32,
    pub dl_rate: u32,
    pub dl_bucket_size: u32,
    pub dl_rate_policy: i32,
    pub add_gw_metadata: bool,
    pub dev_status_req_freq: u32,
    pub report_dev_status_battery: bool,
    pub report_dev_status_margin: bool,
    pub dr_min: u32,
    pub dr_max: u32,
    pub channel_mask: Vec<u8>,
    pub pr_allowed: bool,
    pub hr_allowed: bool,
    pub ra_allowed: bool,
    pub nwk_geo_loc: bool,
    pub target_per: u32,
    pub min_gw_diversity: u32,
    pub gws_private: bool,
}

Fields

id: String

Service-profile ID (UUID string). This will be automatically set on create.

name: String

Service-profile name.

organization_id: i64

Organization ID to which the service-profile is assigned.

network_server_id: i64

Network-server ID on which the service-profile is provisioned.

ul_rate: u32

Token bucket filling rate, including ACKs (packet/h).

ul_bucket_size: u32

Token bucket burst size.

ul_rate_policy: i32

Drop or mark when exceeding ULRate.

dl_rate: u32

Token bucket filling rate, including ACKs (packet/h).

dl_bucket_size: u32

Token bucket burst size.

dl_rate_policy: i32

Drop or mark when exceeding DLRate.

add_gw_metadata: bool

GW metadata (RSSI, SNR, GW geoloc., etc.) are added to the packet sent to AS.

dev_status_req_freq: u32

Frequency to initiate an End-Device status request (request/day).

report_dev_status_battery: bool

Report End-Device battery level to AS.

report_dev_status_margin: bool

Report End-Device margin to AS.

dr_min: u32

Minimum allowed data rate. Used for ADR.

dr_max: u32

Maximum allowed data rate. Used for ADR.

channel_mask: Vec<u8>

Channel mask. sNS does not have to obey (i.e., informative).

pr_allowed: bool

Passive Roaming allowed.

hr_allowed: bool

Handover Roaming allowed.

ra_allowed: bool

Roaming Activation allowed.

nwk_geo_loc: bool

Enable network geolocation service.

target_per: u32

Target Packet Error Rate.

min_gw_diversity: u32

Minimum number of receiving GWs (informative).

gws_private: bool

Gateways under this service-profile are private. This means that these gateways can only be used by devices under the same service-profile.

Implementations

impl ServiceProfile

pub fn ul_rate_policy(&self) -> RatePolicy

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

pub fn set_ul_rate_policy(&mut self, value: RatePolicy)

Sets ul_rate_policy to the provided enum value.

pub fn dl_rate_policy(&self) -> RatePolicy

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

pub fn set_dl_rate_policy(&mut self, value: RatePolicy)

Sets dl_rate_policy to the provided enum value.

Trait Implementations

impl Clone for ServiceProfile

fn clone(&self) -> ServiceProfile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceProfile

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

Formats the value using the given formatter.

impl Default for ServiceProfile

fn default() -> Self

Returns the “default value” for a type.

impl Message for ServiceProfile

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<ServiceProfile> for ServiceProfile

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for ServiceProfile