Class: Google::Apis::SpectrumV1explorer::PawsGetSpectrumBatchResponse

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 response message for the batch available spectrum query contains a schedule of available spectrum for the device at multiple locations.

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

Returns a new instance of PawsGetSpectrumBatchResponse



754
755
756
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 754

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

Instance Attribute Details

#database_change ⇒ Google::Apis::SpectrumV1explorer::DbUpdateSpec

This message is provided by the database to notify devices of an upcoming change to the database URI. Corresponds to the JSON property databaseChange

Returns:



671
672
673
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 671

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



678
679
680
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 678

def device_desc
  @device_desc
end

#geo_spectrum_schedules ⇒ Array<Google::Apis::SpectrumV1explorer::GeoSpectrumSchedule>

The available spectrum batch response must contain a geo-spectrum schedule list, The list may be empty if spectrum is not available. The database may return more than one geo-spectrum schedule to represent future changes to the available spectrum. How far in advance a schedule may be provided depends upon the applicable regulatory domain. The database may return available spectrum for fewer geolocations than requested. The device must not make assumptions about the order of the entries in the list, and must use the geolocation value in each geo-spectrum schedule entry to match available spectrum to a location. Corresponds to the JSON property geoSpectrumSchedules

Returns:



690
691
692
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 690

def geo_spectrum_schedules
  @geo_spectrum_schedules
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "spectrum# pawsGetSpectrumBatchResponse". Corresponds to the JSON property kind

Returns:

  • (String) 


696
697
698
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 696

def kind
  @kind
end

#max_contiguous_bw_hz ⇒ Float

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. Corresponds to the JSON property maxContiguousBwHz

Returns:

  • (Float) 


705
706
707
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 705

def max_contiguous_bw_hz
  @max_contiguous_bw_hz
end

#max_total_bw_hz ⇒ Float

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

Returns:

  • (Float) 


715
716
717
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 715

def max_total_bw_hz
  @max_total_bw_hz
end

#needs_spectrum_report ⇒ Boolean Also known as: needs_spectrum_report?

For regulatory domains that require a spectrum-usage report from devices, the database must return true for this parameter if the geo-spectrum schedules list is not empty; otherwise, the database should 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 should not send the notification. Corresponds to the JSON property needsSpectrumReport

Returns:

  • (Boolean) 


725
726
727
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 725

def needs_spectrum_report
  @needs_spectrum_report
end

#ruleset_info ⇒ Google::Apis::SpectrumV1explorer::RulesetInfo

This contains parameters for the ruleset of a regulatory domain that is communicated using the initialization and available-spectrum processes. Corresponds to the JSON property rulesetInfo

Returns:



732
733
734
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 732

def ruleset_info
  @ruleset_info
end

#timestamp ⇒ String

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

Returns:

  • (String) 


740
741
742
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 740

def timestamp
  @timestamp
end

#type ⇒ String

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

Returns:

  • (String) 


746
747
748
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 746

def type
  @type
end

#version ⇒ String

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

Returns:

  • (String) 


752
753
754
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 752

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 759

def update!(**args)
  @database_change = args[:database_change] if args.key?(:database_change)
  @device_desc = args[:device_desc] if args.key?(:device_desc)
  @geo_spectrum_schedules = args[:geo_spectrum_schedules] if args.key?(:geo_spectrum_schedules)
  @kind = args[:kind] if args.key?(:kind)
  @max_contiguous_bw_hz = args[:max_contiguous_bw_hz] if args.key?(:max_contiguous_bw_hz)
  @max_total_bw_hz = args[:max_total_bw_hz] if args.key?(:max_total_bw_hz)
  @needs_spectrum_report = args[:needs_spectrum_report] if args.key?(:needs_spectrum_report)
  @ruleset_info = args[:ruleset_info] if args.key?(:ruleset_info)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
  @type = args[:type] if args.key?(:type)
  @version = args[:version] if args.key?(:version)
end