Class: Google::Apis::SpectrumV1explorer::DeviceDescriptor

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 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.

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

Returns a new instance of DeviceDescriptor



213
214
215
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 213

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

Instance Attribute Details

#etsi_en_device_categoryString

Specifies the ETSI white space device category. Valid values are the strings master and slave. This field is case-insensitive. Consult the ETSI documentation for details about the device types. Corresponds to the JSON property etsiEnDeviceCategory

Returns:

  • (String)


145
146
147
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 145

def etsi_en_device_category
  @etsi_en_device_category
end

#etsi_en_device_emissions_classString

Specifies the ETSI white space device emissions class. The values are represented by numeric strings, such as 1, 2, etc. Consult the ETSI documentation for details about the device types. Corresponds to the JSON property etsiEnDeviceEmissionsClass

Returns:

  • (String)


152
153
154
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 152

def etsi_en_device_emissions_class
  @etsi_en_device_emissions_class
end

#etsi_en_device_typeString

Specifies the ETSI white space device type. Valid values are single-letter strings, such as A, B, etc. Consult the ETSI documentation for details about the device types. Corresponds to the JSON property etsiEnDeviceType

Returns:

  • (String)


159
160
161
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 159

def etsi_en_device_type
  @etsi_en_device_type
end

#etsi_en_technology_idString

Specifies the ETSI white space device technology identifier. The string value must not exceed 64 characters in length. Consult the ETSI documentation for details about the device types. Corresponds to the JSON property etsiEnTechnologyId

Returns:

  • (String)


166
167
168
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 166

def etsi_en_technology_id
  @etsi_en_technology_id
end

#fcc_idString

Specifies the device's FCC certification identifier. The value is an identifier string whose length should not exceed 32 characters. Note that, in practice, a valid FCC ID may be limited to 19 characters. Corresponds to the JSON property fccId

Returns:

  • (String)


173
174
175
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 173

def fcc_id
  @fcc_id
end

#fcc_tvbd_device_typeString

Specifies the TV Band White Space device type, as defined by the FCC. Valid values are FIXED, MODE_1, MODE_2. Corresponds to the JSON property fccTvbdDeviceType

Returns:

  • (String)


179
180
181
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 179

def fcc_tvbd_device_type
  @fcc_tvbd_device_type
end

#manufacturer_idString

The manufacturer's ID may be required by the regulatory domain. This should represent the name of the device manufacturer, should be consistent across all devices from the same manufacturer, and should be distinct from that of other manufacturers. The string value must not exceed 64 characters in length. Corresponds to the JSON property manufacturerId

Returns:

  • (String)


187
188
189
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 187

def manufacturer_id
  @manufacturer_id
end

#model_idString

The device's model ID may be required by the regulatory domain. The string value must not exceed 64 characters in length. Corresponds to the JSON property modelId

Returns:

  • (String)


193
194
195
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 193

def model_id
  @model_id
end

#ruleset_idsArray<String>

The list of identifiers for rulesets supported by the device. A database may require that the device provide this list before servicing the device requests. If the database does not support any of the rulesets specified in the list, the database may refuse to service the device requests. If present, the list must contain at least one entry. For information about the valid requests, see section 9.2 of the PAWS specification. Currently, FccTvBandWhiteSpace-2010 is the only supported ruleset. Corresponds to the JSON property rulesetIds

Returns:

  • (Array<String>)


205
206
207
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 205

def ruleset_ids
  @ruleset_ids
end

#serial_numberString

The manufacturer's device serial number; required by the applicable regulatory domain. The length of the value must not exceed 64 characters. Corresponds to the JSON property serialNumber

Returns:

  • (String)


211
212
213
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 211

def serial_number
  @serial_number
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



218
219
220
221
222
223
224
225
226
227
228
229
# File 'generated/google/apis/spectrum_v1explorer/classes.rb', line 218

def update!(**args)
  @etsi_en_device_category = args[:etsi_en_device_category] if args.key?(:etsi_en_device_category)
  @etsi_en_device_emissions_class = args[:etsi_en_device_emissions_class] if args.key?(:etsi_en_device_emissions_class)
  @etsi_en_device_type = args[:etsi_en_device_type] if args.key?(:etsi_en_device_type)
  @etsi_en_technology_id = args[:etsi_en_technology_id] if args.key?(:etsi_en_technology_id)
  @fcc_id = args[:fcc_id] if args.key?(:fcc_id)
  @fcc_tvbd_device_type = args[:fcc_tvbd_device_type] if args.key?(:fcc_tvbd_device_type)
  @manufacturer_id = args[:manufacturer_id] if args.key?(:manufacturer_id)
  @model_id = args[:model_id] if args.key?(:model_id)
  @ruleset_ids = args[:ruleset_ids] if args.key?(:ruleset_ids)
  @serial_number = args[:serial_number] if args.key?(:serial_number)
end