Class: Google::Apis::SpectrumV1explorer::RulesetInfo

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

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

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

Returns a new instance of RulesetInfo



1401
1402
1403
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 1401

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

Instance Attribute Details

#authority ⇒ String

The regulatory domain to which the ruleset belongs is required. It must be a 2- letter country code. The device should use this to determine additional device behavior required by the associated regulatory domain. Corresponds to the JSON property authority

Returns:

  • (String) 


1362
1363
1364
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 1362

def authority
  @authority
end

#max_location_change ⇒ Float

The maximum location change in meters is required in the initialization response, but optional otherwise. When the device changes location by more than this specified distance, it must contact the database to get the available spectrum for the new location. If the device is using spectrum that is no longer available, it must immediately cease use of the spectrum under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response. Corresponds to the JSON property maxLocationChange

Returns:

  • (Float) 


1374
1375
1376
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 1374

def max_location_change
  @max_location_change
end

#max_polling_secs ⇒ Fixnum

The maximum duration, in seconds, between requests for available spectrum. It is required in the initialization response, but optional otherwise. The device must contact the database to get available spectrum no less frequently than this duration. If the new spectrum information indicates that the device is using spectrum that is no longer available, it must immediately cease use of those frequencies under rules for database-managed spectrum. If this value is provided within the context of an available-spectrum response, it takes precedence over the value within the initialization response. Corresponds to the JSON property maxPollingSecs

Returns:

  • (Fixnum) 


1386
1387
1388
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 1386

def max_polling_secs
  @max_polling_secs
end

#ruleset_ids ⇒ Array<String>

The identifiers of the rulesets supported for the device's location. The database should include at least one applicable ruleset in the initialization response. The device may use the ruleset identifiers to determine parameters to include in subsequent requests. Within the context of the available- spectrum responses, the database should include the identifier of the ruleset that it used to determine the available-spectrum response. If included, the device must use the specified ruleset to interpret the response. If the device does not support the indicated ruleset, it must not operate in the spectrum governed by the ruleset. Corresponds to the JSON property rulesetIds

Returns:

  • (Array<String>) 


1399
1400
1401
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 1399

def ruleset_ids
  @ruleset_ids
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1406
1407
1408
1409
1410
1411
 
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 1406

def update!(**args)
  @authority = args[:authority] if args.key?(:authority)
  @max_location_change = args[:max_location_change] if args.key?(:max_location_change)
  @max_polling_secs = args[:max_polling_secs] if args.key?(:max_polling_secs)
  @ruleset_ids = args[:ruleset_ids] if args.key?(:ruleset_ids)
end