Class: Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/spectrum_v1explorer/classes.rb,
generated/google/apis/spectrum_v1explorer/representations.rb,
generated/google/apis/spectrum_v1explorer/representations.rb

Overview

The request message for a batch available spectrum query protocol.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PawsGetSpectrumBatchRequest

Returns a new instance of PawsGetSpectrumBatchRequest



644
645
646
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 644

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#antenna ⇒ Google::Apis::SpectrumV1explorer::AntennaCharacteristics

Antenna characteristics provide additional information, such as the antenna height, antenna type, etc. Whether antenna characteristics must be provided in a request depends on the device type and regulatory domain. Corresponds to the JSON property antenna

Returns:



566
567
568
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 566

def antenna
  @antenna
end

#capabilities ⇒ Google::Apis::SpectrumV1explorer::DeviceCapabilities

Device capabilities provide additional information that may be used by a device to provide additional information to the database that may help it to determine available spectrum. If the database does not support device capabilities it will ignore the parameter altogether. Corresponds to the JSON property capabilities

Returns:



574
575
576
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 574

def capabilities
  @capabilities
end

#device_desc ⇒ Google::Apis::SpectrumV1explorer::DeviceDescriptor

The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. Corresponds to the JSON property deviceDesc

Returns:



581
582
583
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 581

def device_desc
  @device_desc
end

#locations ⇒ Array<Google::Apis::SpectrumV1explorer::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). Corresponds to the JSON property locations

Returns:



598
599
600
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 598

def locations
  @locations
end

#master_device_desc ⇒ Google::Apis::SpectrumV1explorer::DeviceDescriptor

The device descriptor contains parameters that identify the specific device, such as its manufacturer serial number, regulatory-specific identifier (e.g., FCC ID), and any other device characteristics required by regulatory domains. Corresponds to the JSON property masterDeviceDesc

Returns:



605
606
607
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 605

def master_device_desc
  @master_device_desc
end

#owner ⇒ Google::Apis::SpectrumV1explorer::DeviceOwner

This parameter contains device-owner information required as part of device registration. The regulatory domains may require additional parameters. All contact information must be expressed using the structure defined by the vCard format specification. Only the contact fields of vCard are supported:

  • fn: Full name of an individual
  • org: Name of the organization
  • adr: Address fields
  • tel: Telephone numbers
  • email: Email addresses Note that the vCard specification defines maximum lengths for each field. Corresponds to the JSON property owner

Returns:



619
620
621
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 619

def owner
  @owner
end

#request_type ⇒ 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. Corresponds to the JSON property requestType

Returns:

  • (String) 


630
631
632
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 630

def request_type
  @request_type
end

#type ⇒ String

The message type (e.g., INIT_REQ, AVAIL_SPECTRUM_REQ, ...). Required field. Corresponds to the JSON property type

Returns:

  • (String) 


636
637
638
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 636

def type
  @type
end

#version ⇒ String

The PAWS version. Must be exactly 1.0. Required field. Corresponds to the JSON property version

Returns:

  • (String) 


642
643
644
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 642

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



649
650
651
652
653
654
655
656
657
658
659
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 649

def update!(**args)
  @antenna = args[:antenna] if args.key?(:antenna)
  @capabilities = args[:capabilities] if args.key?(:capabilities)
  @device_desc = args[:device_desc] if args.key?(:device_desc)
  @locations = args[:locations] if args.key?(:locations)
  @master_device_desc = args[:master_device_desc] if args.key?(:master_device_desc)
  @owner = args[:owner] if args.key?(:owner)
  @request_type = args[:request_type] if args.key?(:request_type)
  @type = args[:type] if args.key?(:type)
  @version = args[:version] if args.key?(:version)
end