Struct google_spectrum1_explorer::api::PawsGetSpectrumBatchRequest

pub struct PawsGetSpectrumBatchRequest {
    pub antenna: Option<AntennaCharacteristics>,
    pub capabilities: Option<DeviceCapabilities>,
    pub device_desc: Option<DeviceDescriptor>,
    pub locations: Option<Vec<GeoLocation>>,
    pub master_device_desc: Option<DeviceDescriptor>,
    pub owner: Option<DeviceOwner>,
    pub request_type: Option<String>,
    pub type_: Option<String>,
    pub version: Option<String>,
}

The request message for a batch available spectrum query protocol.

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 batch paws (request)

Fields

antenna: Option<AntennaCharacteristics>

Depending on device type and regulatory domain, antenna characteristics may be required.

capabilities: Option<DeviceCapabilities>

The master device may include its device capabilities to limit the available-spectrum batch response to the spectrum that is compatible with its capabilities. The database should not return spectrum that is incompatible with the specified capabilities.

device_desc: Option<DeviceDescriptor>

When the available spectrum request is made on behalf of a specific device (a master or slave device), device descriptor information for the device on whose behalf the request is made is required (in such cases, the requestType parameter must be empty). When a requestType value is specified, device descriptor information may be optional or required according to the rules of the applicable regulatory domain.

locations: Option<Vec<GeoLocation>>

A geolocation list is required. This allows a device to specify its current location plus additional anticipated locations when allowed by the regulatory domain. At least one location must be included. Geolocation must be given as the location of the radiation center of the device’s antenna. If a location specifies a region, rather than a point, the database may return an UNIMPLEMENTED error if it does not support query by region.

There is no upper limit on the number of locations included in a available spectrum batch request, but the database may restrict the number of locations it supports by returning a response with fewer locations than specified in the batch request. Note that geolocations must be those of the master device (a device with geolocation capability that makes an available spectrum batch request), whether the master device is making the request on its own behalf or on behalf of a slave device (one without geolocation capability).

master_device_desc: Option<DeviceDescriptor>

When an available spectrum batch request is made by the master device (a device with geolocation capability) on behalf of a slave device (a device without geolocation capability), the rules of the applicable regulatory domain may require the master device to provide its own device descriptor information (in addition to device descriptor information for the slave device in a separate parameter).

owner: Option<DeviceOwner>

Depending on device type and regulatory domain, device owner information may be included in an available spectrum batch request. This allows the device to register and get spectrum-availability information in a single request.

request_type: Option<String>

The request type parameter is an optional parameter that can be used to modify an available spectrum batch request, but its use depends on applicable regulatory rules. For example, It may be used to request generic slave device parameters without having to specify the device descriptor for a specific device. When the requestType parameter is missing, the request is for a specific device (master or slave), and the device descriptor parameter for the device on whose behalf the batch request is made is required.

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 PawsGetSpectrumBatchRequest

fn clone(&self) -> PawsGetSpectrumBatchRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PawsGetSpectrumBatchRequest

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

Formats the value using the given formatter.

impl Default for PawsGetSpectrumBatchRequest

fn default() -> PawsGetSpectrumBatchRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PawsGetSpectrumBatchRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PawsGetSpectrumBatchRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for PawsGetSpectrumBatchRequest