Class: Google::Apis::SpectrumV1explorer::PawsGetSpectrumRequest

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 the available spectrum query protocol which must include the device's geolocation.

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) ⇒ PawsGetSpectrumRequest

Returns a new instance of PawsGetSpectrumRequest



850
851
852
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 850

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:



784
785
786
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 784

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:



792
793
794
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 792

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:



799
800
801
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 799

def device_desc
  @device_desc
end

#location ⇒ Google::Apis::SpectrumV1explorer::GeoLocation

This parameter is used to specify the geolocation of the device. Corresponds to the JSON property location

Returns:



804
805
806
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 804

def location
  @location
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:



811
812
813
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 811

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:



825
826
827
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 825

def owner
  @owner
end

#request_type ⇒ String

The request type parameter is an optional parameter that can be used to modify an available spectrum request, but its use depends on applicable regulatory rules. It may be used, for example, 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 deviceDesc parameter for the device on whose behalf the request is made is required. Corresponds to the JSON property requestType

Returns:

  • (String) 


836
837
838
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 836

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) 


842
843
844
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 842

def type
  @type
end

#version ⇒ String

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

Returns:

  • (String) 


848
849
850
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 848

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



855
856
857
858
859
860
861
862
863
864
865
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 855

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)
  @location = args[:location] if args.key?(:location)
  @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