Class: Google::Apis::SpectrumV1explorer::PawsGetSpectrumResponse

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 available spectrum query which contains a schedule of available spectrum for the device.

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

Returns a new instance of PawsGetSpectrumResponse



957
958
959
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 957

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:



877
878
879
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 877

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:



884
885
886
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 884

def device_desc
  @device_desc
end

#kind ⇒ String

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

Returns:

  • (String) 


890
891
892
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 890

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) 


899
900
901
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 899

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

Returns:

  • (Float) 


909
910
911
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 909

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

Returns:

  • (Boolean) 


919
920
921
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 919

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:



926
927
928
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 926

def ruleset_info
  @ruleset_info
end

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

Returns:



935
936
937
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 935

def spectrum_schedules
  @spectrum_schedules
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 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) 


943
944
945
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 943

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) 


949
950
951
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 949

def type
  @type
end

#version ⇒ String

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

Returns:

  • (String) 


955
956
957
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 955

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



962
963
964
965
966
967
968
969
970
971
972
973
974
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 962

def update!(**args)
  @database_change = args[:database_change] if args.key?(:database_change)
  @device_desc = args[:device_desc] if args.key?(:device_desc)
  @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)
  @spectrum_schedules = args[:spectrum_schedules] if args.key?(:spectrum_schedules)
  @timestamp = args[:timestamp] if args.key?(:timestamp)
  @type = args[:type] if args.key?(:type)
  @version = args[:version] if args.key?(:version)
end