Struct google_spectrum1_explorer::api::PawsGetSpectrumResponse

pub struct PawsGetSpectrumResponse {
    pub database_change: Option<DbUpdateSpec>,
    pub device_desc: Option<DeviceDescriptor>,
    pub kind: Option<String>,
    pub max_contiguous_bw_hz: Option<f64>,
    pub max_total_bw_hz: Option<f64>,
    pub needs_spectrum_report: Option<bool>,
    pub ruleset_info: Option<RulesetInfo>,
    pub spectrum_schedules: Option<Vec<SpectrumSchedule>>,
    pub timestamp: Option<String>,
    pub type_: Option<String>,
    pub version: Option<String>,
}

The response message for the available spectrum query which contains a schedule of available spectrum for the device.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• get spectrum paws (response)

Fields

database_change: Option<DbUpdateSpec>

A database may include the databaseChange parameter to notify a device of a change to its database URI, providing one or more alternate database URIs. The device should use this information to update its list of pre-configured databases by (only) replacing its entry for the responding database with the list of alternate URIs.

device_desc: Option<DeviceDescriptor>

The database must return, in its available spectrum response, the device descriptor information it received in the master device’s available spectrum request.

kind: Option<String>

Identifies what kind of resource this is. Value: the fixed string “spectrum#pawsGetSpectrumResponse”.

max_contiguous_bw_hz: Option<f64>

The database may return a constraint on the allowed maximum contiguous bandwidth (in Hertz). A regulatory domain may require the database to return this parameter. When this parameter is present in the response, the device must apply this constraint to its spectrum-selection logic to ensure that no single block of spectrum has bandwidth that exceeds this value.

max_total_bw_hz: Option<f64>

The database may return a constraint on the allowed maximum total bandwidth (in Hertz), which need not be contiguous. A regulatory domain may require the database to return this parameter. When this parameter is present in the available spectrum response, the device must apply this constraint to its spectrum-selection logic to ensure that total bandwidth does not exceed this value.

needs_spectrum_report: Option<bool>

For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the spectrum schedule list is not empty; otherwise, the database will either return false or omit this parameter. If this parameter is present and its value is true, the device must send a spectrum use notify message to the database; otherwise, the device must not send the notification.

ruleset_info: Option<RulesetInfo>

The database should return ruleset information, which identifies the applicable regulatory authority and ruleset for the available spectrum response. If included, the device must use the corresponding ruleset to interpret the response. Values provided in the returned ruleset information, such as maxLocationChange, take precedence over any conflicting values provided in the ruleset information returned in a prior initialization response sent by the database to the device.

spectrum_schedules: Option<Vec<SpectrumSchedule>>

The available spectrum response must contain a spectrum schedule list. The list may be empty if spectrum is not available. The database may return more than one spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends on the applicable regulatory domain.

timestamp: Option<String>

The database includes a timestamp of the form YYYY-MM-DDThh:mm:ssZ (Internet timestamp format per RFC3339) in its available spectrum response. The timestamp should be used by the device as a reference for the start and stop times specified in the response spectrum schedules.

type_: Option<String>

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, …).

Required field.

version: Option<String>

The PAWS version. Must be exactly 1.0.

Required field.

Trait Implementations

impl Clone for PawsGetSpectrumResponse

fn clone(&self) -> PawsGetSpectrumResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PawsGetSpectrumResponse

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

Formats the value using the given formatter.

impl Default for PawsGetSpectrumResponse

fn default() -> PawsGetSpectrumResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PawsGetSpectrumResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PawsGetSpectrumResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ResponseResult for PawsGetSpectrumResponse