1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.nodes.html">nodes</a> . <a href="sasportal_v1alpha1.nodes.devices.html">devices</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a device under a node or customer.</p> 83<p class="toc_element"> 84 <code><a href="#createSigned">createSigned(parent, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Creates a signed device under a node or customer.</p> 86<p class="toc_element"> 87 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Deletes a device.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 91<p class="firstline">Gets details about a device.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 94<p class="firstline">Lists devices under a node or customer.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Moves a device under another node or customer.</p> 101<p class="toc_element"> 102 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 103<p class="firstline">Updates a device.</p> 104<p class="toc_element"> 105 <code><a href="#signDevice">signDevice(name, body=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Signs a device.</p> 107<p class="toc_element"> 108 <code><a href="#updateSigned">updateSigned(name, body=None, x__xgafv=None)</a></code></p> 109<p class="firstline">Updates a signed device.</p> 110<h3>Method Details</h3> 111<div class="method"> 112 <code class="details" id="close">close()</code> 113 <pre>Close httplib2 connections.</pre> 114</div> 115 116<div class="method"> 117 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 118 <pre>Creates a device under a node or customer. 119 120Args: 121 parent: string, Required. The name of the parent resource. (required) 122 body: object, The request body. 123 The object takes the form of: 124 125{ 126 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 127 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 128 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 129 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 130 }, 131 "callSign": "A String", # The call sign of the device operator. 132 "category": "A String", # FCC category of the device. 133 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 134 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 135 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 136 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 137 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 138 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 139 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 140 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 141 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 142 "heightType": "A String", # Specifies how the height is measured. 143 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 144 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 145 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 146 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 147 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 148 }, 149 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 150 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 151 "A String", 152 ], 153 "model": { # Information about the model of the device. # Information about this device model. 154 "firmwareVersion": "A String", # The firmware version of the device. 155 "hardwareVersion": "A String", # The hardware version of the device. 156 "name": "A String", # The name of the device model. 157 "softwareVersion": "A String", # The software version of the device. 158 "vendor": "A String", # The name of the device vendor. 159 }, 160 "state": "A String", # State of the configuration. 161 "updateTime": "A String", # Output only. The last time the device configuration was edited. 162 "userId": "A String", # The identifier of a device user. 163 }, 164 "currentChannels": [ # Output only. Current channels with scores. 165 { # The channel with score. 166 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 167 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 168 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 169 }, 170 "score": 3.14, # The channel score, normalized to be in [0,100]. 171 }, 172 ], 173 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 174 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 175 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 176 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 177 }, 178 "displayName": "A String", # Device display name. 179 "fccId": "A String", # The FCC identifier of the device. 180 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 181 { # Frequency range from `low_frequency` to `high_frequency`. 182 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 183 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 184 }, 185 ], 186 "grants": [ # Output only. Grants held by the device. 187 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 188 "channelType": "A String", # Type of channel used. 189 "expireTime": "A String", # The expiration time of the grant. 190 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 191 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 192 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 193 }, 194 "grantId": "A String", # Grant Id. 195 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 196 "moveList": [ # The DPA move lists on which this grant appears. 197 { # An entry in a DPA's move list. 198 "dpaId": "A String", # The ID of the DPA. 199 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 200 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 201 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 202 }, 203 }, 204 ], 205 "state": "A String", # State of the grant. 206 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 207 "A String", 208 ], 209 }, 210 ], 211 "name": "A String", # Output only. The resource path name. 212 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 213 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 214 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 215 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 216 }, 217 "callSign": "A String", # The call sign of the device operator. 218 "category": "A String", # FCC category of the device. 219 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 220 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 221 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 222 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 223 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 224 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 225 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 226 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 227 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 228 "heightType": "A String", # Specifies how the height is measured. 229 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 230 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 231 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 232 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 233 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 234 }, 235 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 236 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 237 "A String", 238 ], 239 "model": { # Information about the model of the device. # Information about this device model. 240 "firmwareVersion": "A String", # The firmware version of the device. 241 "hardwareVersion": "A String", # The hardware version of the device. 242 "name": "A String", # The name of the device model. 243 "softwareVersion": "A String", # The software version of the device. 244 "vendor": "A String", # The name of the device vendor. 245 }, 246 "state": "A String", # State of the configuration. 247 "updateTime": "A String", # Output only. The last time the device configuration was edited. 248 "userId": "A String", # The identifier of a device user. 249 }, 250 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 251 "state": "A String", # Output only. Device state. 252} 253 254 x__xgafv: string, V1 error format. 255 Allowed values 256 1 - v1 error format 257 2 - v2 error format 258 259Returns: 260 An object of the form: 261 262 { 263 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 264 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 265 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 266 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 267 }, 268 "callSign": "A String", # The call sign of the device operator. 269 "category": "A String", # FCC category of the device. 270 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 271 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 272 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 273 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 274 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 275 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 276 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 277 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 278 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 279 "heightType": "A String", # Specifies how the height is measured. 280 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 281 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 282 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 283 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 284 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 285 }, 286 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 287 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 288 "A String", 289 ], 290 "model": { # Information about the model of the device. # Information about this device model. 291 "firmwareVersion": "A String", # The firmware version of the device. 292 "hardwareVersion": "A String", # The hardware version of the device. 293 "name": "A String", # The name of the device model. 294 "softwareVersion": "A String", # The software version of the device. 295 "vendor": "A String", # The name of the device vendor. 296 }, 297 "state": "A String", # State of the configuration. 298 "updateTime": "A String", # Output only. The last time the device configuration was edited. 299 "userId": "A String", # The identifier of a device user. 300 }, 301 "currentChannels": [ # Output only. Current channels with scores. 302 { # The channel with score. 303 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 304 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 305 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 306 }, 307 "score": 3.14, # The channel score, normalized to be in [0,100]. 308 }, 309 ], 310 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 311 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 312 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 313 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 314 }, 315 "displayName": "A String", # Device display name. 316 "fccId": "A String", # The FCC identifier of the device. 317 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 318 { # Frequency range from `low_frequency` to `high_frequency`. 319 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 320 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 321 }, 322 ], 323 "grants": [ # Output only. Grants held by the device. 324 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 325 "channelType": "A String", # Type of channel used. 326 "expireTime": "A String", # The expiration time of the grant. 327 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 328 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 329 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 330 }, 331 "grantId": "A String", # Grant Id. 332 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 333 "moveList": [ # The DPA move lists on which this grant appears. 334 { # An entry in a DPA's move list. 335 "dpaId": "A String", # The ID of the DPA. 336 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 337 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 338 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 339 }, 340 }, 341 ], 342 "state": "A String", # State of the grant. 343 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 344 "A String", 345 ], 346 }, 347 ], 348 "name": "A String", # Output only. The resource path name. 349 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 350 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 351 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 352 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 353 }, 354 "callSign": "A String", # The call sign of the device operator. 355 "category": "A String", # FCC category of the device. 356 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 357 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 358 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 359 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 360 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 361 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 362 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 363 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 364 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 365 "heightType": "A String", # Specifies how the height is measured. 366 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 367 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 368 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 369 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 370 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 371 }, 372 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 373 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 374 "A String", 375 ], 376 "model": { # Information about the model of the device. # Information about this device model. 377 "firmwareVersion": "A String", # The firmware version of the device. 378 "hardwareVersion": "A String", # The hardware version of the device. 379 "name": "A String", # The name of the device model. 380 "softwareVersion": "A String", # The software version of the device. 381 "vendor": "A String", # The name of the device vendor. 382 }, 383 "state": "A String", # State of the configuration. 384 "updateTime": "A String", # Output only. The last time the device configuration was edited. 385 "userId": "A String", # The identifier of a device user. 386 }, 387 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 388 "state": "A String", # Output only. Device state. 389}</pre> 390</div> 391 392<div class="method"> 393 <code class="details" id="createSigned">createSigned(parent, body=None, x__xgafv=None)</code> 394 <pre>Creates a signed device under a node or customer. 395 396Args: 397 parent: string, Required. The name of the parent resource. (required) 398 body: object, The request body. 399 The object takes the form of: 400 401{ # Request for CreateSignedDevice. 402 "encodedDevice": "A String", # Required. JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set. 403 "installerId": "A String", # Required. Unique installer id (CPI ID) from the Certified Professional Installers database. 404} 405 406 x__xgafv: string, V1 error format. 407 Allowed values 408 1 - v1 error format 409 2 - v2 error format 410 411Returns: 412 An object of the form: 413 414 { 415 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 416 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 417 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 418 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 419 }, 420 "callSign": "A String", # The call sign of the device operator. 421 "category": "A String", # FCC category of the device. 422 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 423 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 424 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 425 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 426 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 427 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 428 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 429 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 430 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 431 "heightType": "A String", # Specifies how the height is measured. 432 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 433 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 434 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 435 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 436 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 437 }, 438 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 439 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 440 "A String", 441 ], 442 "model": { # Information about the model of the device. # Information about this device model. 443 "firmwareVersion": "A String", # The firmware version of the device. 444 "hardwareVersion": "A String", # The hardware version of the device. 445 "name": "A String", # The name of the device model. 446 "softwareVersion": "A String", # The software version of the device. 447 "vendor": "A String", # The name of the device vendor. 448 }, 449 "state": "A String", # State of the configuration. 450 "updateTime": "A String", # Output only. The last time the device configuration was edited. 451 "userId": "A String", # The identifier of a device user. 452 }, 453 "currentChannels": [ # Output only. Current channels with scores. 454 { # The channel with score. 455 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 456 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 457 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 458 }, 459 "score": 3.14, # The channel score, normalized to be in [0,100]. 460 }, 461 ], 462 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 463 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 464 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 465 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 466 }, 467 "displayName": "A String", # Device display name. 468 "fccId": "A String", # The FCC identifier of the device. 469 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 470 { # Frequency range from `low_frequency` to `high_frequency`. 471 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 472 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 473 }, 474 ], 475 "grants": [ # Output only. Grants held by the device. 476 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 477 "channelType": "A String", # Type of channel used. 478 "expireTime": "A String", # The expiration time of the grant. 479 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 480 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 481 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 482 }, 483 "grantId": "A String", # Grant Id. 484 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 485 "moveList": [ # The DPA move lists on which this grant appears. 486 { # An entry in a DPA's move list. 487 "dpaId": "A String", # The ID of the DPA. 488 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 489 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 490 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 491 }, 492 }, 493 ], 494 "state": "A String", # State of the grant. 495 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 496 "A String", 497 ], 498 }, 499 ], 500 "name": "A String", # Output only. The resource path name. 501 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 502 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 503 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 504 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 505 }, 506 "callSign": "A String", # The call sign of the device operator. 507 "category": "A String", # FCC category of the device. 508 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 509 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 510 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 511 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 512 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 513 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 514 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 515 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 516 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 517 "heightType": "A String", # Specifies how the height is measured. 518 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 519 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 520 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 521 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 522 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 523 }, 524 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 525 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 526 "A String", 527 ], 528 "model": { # Information about the model of the device. # Information about this device model. 529 "firmwareVersion": "A String", # The firmware version of the device. 530 "hardwareVersion": "A String", # The hardware version of the device. 531 "name": "A String", # The name of the device model. 532 "softwareVersion": "A String", # The software version of the device. 533 "vendor": "A String", # The name of the device vendor. 534 }, 535 "state": "A String", # State of the configuration. 536 "updateTime": "A String", # Output only. The last time the device configuration was edited. 537 "userId": "A String", # The identifier of a device user. 538 }, 539 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 540 "state": "A String", # Output only. Device state. 541}</pre> 542</div> 543 544<div class="method"> 545 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 546 <pre>Deletes a device. 547 548Args: 549 name: string, Required. The name of the device. (required) 550 x__xgafv: string, V1 error format. 551 Allowed values 552 1 - v1 error format 553 2 - v2 error format 554 555Returns: 556 An object of the form: 557 558 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 559}</pre> 560</div> 561 562<div class="method"> 563 <code class="details" id="get">get(name, x__xgafv=None)</code> 564 <pre>Gets details about a device. 565 566Args: 567 name: string, Required. The name of the device. (required) 568 x__xgafv: string, V1 error format. 569 Allowed values 570 1 - v1 error format 571 2 - v2 error format 572 573Returns: 574 An object of the form: 575 576 { 577 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 578 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 579 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 580 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 581 }, 582 "callSign": "A String", # The call sign of the device operator. 583 "category": "A String", # FCC category of the device. 584 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 585 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 586 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 587 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 588 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 589 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 590 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 591 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 592 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 593 "heightType": "A String", # Specifies how the height is measured. 594 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 595 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 596 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 597 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 598 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 599 }, 600 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 601 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 602 "A String", 603 ], 604 "model": { # Information about the model of the device. # Information about this device model. 605 "firmwareVersion": "A String", # The firmware version of the device. 606 "hardwareVersion": "A String", # The hardware version of the device. 607 "name": "A String", # The name of the device model. 608 "softwareVersion": "A String", # The software version of the device. 609 "vendor": "A String", # The name of the device vendor. 610 }, 611 "state": "A String", # State of the configuration. 612 "updateTime": "A String", # Output only. The last time the device configuration was edited. 613 "userId": "A String", # The identifier of a device user. 614 }, 615 "currentChannels": [ # Output only. Current channels with scores. 616 { # The channel with score. 617 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 618 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 619 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 620 }, 621 "score": 3.14, # The channel score, normalized to be in [0,100]. 622 }, 623 ], 624 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 625 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 626 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 627 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 628 }, 629 "displayName": "A String", # Device display name. 630 "fccId": "A String", # The FCC identifier of the device. 631 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 632 { # Frequency range from `low_frequency` to `high_frequency`. 633 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 634 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 635 }, 636 ], 637 "grants": [ # Output only. Grants held by the device. 638 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 639 "channelType": "A String", # Type of channel used. 640 "expireTime": "A String", # The expiration time of the grant. 641 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 642 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 643 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 644 }, 645 "grantId": "A String", # Grant Id. 646 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 647 "moveList": [ # The DPA move lists on which this grant appears. 648 { # An entry in a DPA's move list. 649 "dpaId": "A String", # The ID of the DPA. 650 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 651 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 652 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 653 }, 654 }, 655 ], 656 "state": "A String", # State of the grant. 657 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 658 "A String", 659 ], 660 }, 661 ], 662 "name": "A String", # Output only. The resource path name. 663 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 664 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 665 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 666 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 667 }, 668 "callSign": "A String", # The call sign of the device operator. 669 "category": "A String", # FCC category of the device. 670 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 671 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 672 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 673 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 674 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 675 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 676 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 677 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 678 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 679 "heightType": "A String", # Specifies how the height is measured. 680 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 681 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 682 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 683 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 684 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 685 }, 686 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 687 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 688 "A String", 689 ], 690 "model": { # Information about the model of the device. # Information about this device model. 691 "firmwareVersion": "A String", # The firmware version of the device. 692 "hardwareVersion": "A String", # The hardware version of the device. 693 "name": "A String", # The name of the device model. 694 "softwareVersion": "A String", # The software version of the device. 695 "vendor": "A String", # The name of the device vendor. 696 }, 697 "state": "A String", # State of the configuration. 698 "updateTime": "A String", # Output only. The last time the device configuration was edited. 699 "userId": "A String", # The identifier of a device user. 700 }, 701 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 702 "state": "A String", # Output only. Device state. 703}</pre> 704</div> 705 706<div class="method"> 707 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 708 <pre>Lists devices under a node or customer. 709 710Args: 711 parent: string, Required. The name of the parent resource. (required) 712 filter: string, The filter expression. The filter should have one of the following formats: "sn=123454" or "display_name=MyDevice". sn corresponds to serial number of the device. The filter is case insensitive. 713 pageSize: integer, The maximum number of devices to return in the response. If empty or zero, all devices will be listed. Must be in the range [0, 1000]. 714 pageToken: string, A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. 715 x__xgafv: string, V1 error format. 716 Allowed values 717 1 - v1 error format 718 2 - v2 error format 719 720Returns: 721 An object of the form: 722 723 { # Response for ListDevices. 724 "devices": [ # The devices that match the request. 725 { 726 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 727 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 728 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 729 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 730 }, 731 "callSign": "A String", # The call sign of the device operator. 732 "category": "A String", # FCC category of the device. 733 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 734 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 735 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 736 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 737 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 738 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 739 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 740 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 741 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 742 "heightType": "A String", # Specifies how the height is measured. 743 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 744 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 745 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 746 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 747 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 748 }, 749 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 750 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 751 "A String", 752 ], 753 "model": { # Information about the model of the device. # Information about this device model. 754 "firmwareVersion": "A String", # The firmware version of the device. 755 "hardwareVersion": "A String", # The hardware version of the device. 756 "name": "A String", # The name of the device model. 757 "softwareVersion": "A String", # The software version of the device. 758 "vendor": "A String", # The name of the device vendor. 759 }, 760 "state": "A String", # State of the configuration. 761 "updateTime": "A String", # Output only. The last time the device configuration was edited. 762 "userId": "A String", # The identifier of a device user. 763 }, 764 "currentChannels": [ # Output only. Current channels with scores. 765 { # The channel with score. 766 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 767 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 768 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 769 }, 770 "score": 3.14, # The channel score, normalized to be in [0,100]. 771 }, 772 ], 773 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 774 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 775 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 776 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 777 }, 778 "displayName": "A String", # Device display name. 779 "fccId": "A String", # The FCC identifier of the device. 780 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 781 { # Frequency range from `low_frequency` to `high_frequency`. 782 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 783 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 784 }, 785 ], 786 "grants": [ # Output only. Grants held by the device. 787 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 788 "channelType": "A String", # Type of channel used. 789 "expireTime": "A String", # The expiration time of the grant. 790 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 791 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 792 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 793 }, 794 "grantId": "A String", # Grant Id. 795 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 796 "moveList": [ # The DPA move lists on which this grant appears. 797 { # An entry in a DPA's move list. 798 "dpaId": "A String", # The ID of the DPA. 799 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 800 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 801 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 802 }, 803 }, 804 ], 805 "state": "A String", # State of the grant. 806 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 807 "A String", 808 ], 809 }, 810 ], 811 "name": "A String", # Output only. The resource path name. 812 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 813 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 814 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 815 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 816 }, 817 "callSign": "A String", # The call sign of the device operator. 818 "category": "A String", # FCC category of the device. 819 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 820 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 821 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 822 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 823 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 824 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 825 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 826 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 827 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 828 "heightType": "A String", # Specifies how the height is measured. 829 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 830 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 831 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 832 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 833 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 834 }, 835 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 836 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 837 "A String", 838 ], 839 "model": { # Information about the model of the device. # Information about this device model. 840 "firmwareVersion": "A String", # The firmware version of the device. 841 "hardwareVersion": "A String", # The hardware version of the device. 842 "name": "A String", # The name of the device model. 843 "softwareVersion": "A String", # The software version of the device. 844 "vendor": "A String", # The name of the device vendor. 845 }, 846 "state": "A String", # State of the configuration. 847 "updateTime": "A String", # Output only. The last time the device configuration was edited. 848 "userId": "A String", # The identifier of a device user. 849 }, 850 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 851 "state": "A String", # Output only. Device state. 852 }, 853 ], 854 "nextPageToken": "A String", # A pagination token returned from a previous call to ListDevices that indicates from where listing should continue. If the field is missing or empty, it means there is no more devices. 855}</pre> 856</div> 857 858<div class="method"> 859 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 860 <pre>Retrieves the next page of results. 861 862Args: 863 previous_request: The request for the previous page. (required) 864 previous_response: The response from the request for the previous page. (required) 865 866Returns: 867 A request object that you can call 'execute()' on to request the next 868 page. Returns None if there are no more items in the collection. 869 </pre> 870</div> 871 872<div class="method"> 873 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code> 874 <pre>Moves a device under another node or customer. 875 876Args: 877 name: string, Required. The name of the device to move. (required) 878 body: object, The request body. 879 The object takes the form of: 880 881{ # Request for MoveDevice. 882 "destination": "A String", # Required. The name of the new parent resource node or customer to reparent the device under. 883} 884 885 x__xgafv: string, V1 error format. 886 Allowed values 887 1 - v1 error format 888 2 - v2 error format 889 890Returns: 891 An object of the form: 892 893 { # This resource represents a long-running operation that is the result of a network API call. 894 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 895 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 896 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 897 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 898 { 899 "a_key": "", # Properties of the object. Contains field @type with type URL. 900 }, 901 ], 902 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 903 }, 904 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 905 "a_key": "", # Properties of the object. Contains field @type with type URL. 906 }, 907 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 908 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 909 "a_key": "", # Properties of the object. Contains field @type with type URL. 910 }, 911}</pre> 912</div> 913 914<div class="method"> 915 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 916 <pre>Updates a device. 917 918Args: 919 name: string, Output only. The resource path name. (required) 920 body: object, The request body. 921 The object takes the form of: 922 923{ 924 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 925 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 926 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 927 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 928 }, 929 "callSign": "A String", # The call sign of the device operator. 930 "category": "A String", # FCC category of the device. 931 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 932 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 933 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 934 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 935 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 936 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 937 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 938 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 939 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 940 "heightType": "A String", # Specifies how the height is measured. 941 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 942 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 943 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 944 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 945 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 946 }, 947 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 948 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 949 "A String", 950 ], 951 "model": { # Information about the model of the device. # Information about this device model. 952 "firmwareVersion": "A String", # The firmware version of the device. 953 "hardwareVersion": "A String", # The hardware version of the device. 954 "name": "A String", # The name of the device model. 955 "softwareVersion": "A String", # The software version of the device. 956 "vendor": "A String", # The name of the device vendor. 957 }, 958 "state": "A String", # State of the configuration. 959 "updateTime": "A String", # Output only. The last time the device configuration was edited. 960 "userId": "A String", # The identifier of a device user. 961 }, 962 "currentChannels": [ # Output only. Current channels with scores. 963 { # The channel with score. 964 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 965 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 966 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 967 }, 968 "score": 3.14, # The channel score, normalized to be in [0,100]. 969 }, 970 ], 971 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 972 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 973 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 974 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 975 }, 976 "displayName": "A String", # Device display name. 977 "fccId": "A String", # The FCC identifier of the device. 978 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 979 { # Frequency range from `low_frequency` to `high_frequency`. 980 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 981 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 982 }, 983 ], 984 "grants": [ # Output only. Grants held by the device. 985 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 986 "channelType": "A String", # Type of channel used. 987 "expireTime": "A String", # The expiration time of the grant. 988 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 989 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 990 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 991 }, 992 "grantId": "A String", # Grant Id. 993 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 994 "moveList": [ # The DPA move lists on which this grant appears. 995 { # An entry in a DPA's move list. 996 "dpaId": "A String", # The ID of the DPA. 997 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 998 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 999 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1000 }, 1001 }, 1002 ], 1003 "state": "A String", # State of the grant. 1004 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 1005 "A String", 1006 ], 1007 }, 1008 ], 1009 "name": "A String", # Output only. The resource path name. 1010 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 1011 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1012 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1013 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1014 }, 1015 "callSign": "A String", # The call sign of the device operator. 1016 "category": "A String", # FCC category of the device. 1017 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1018 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1019 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1020 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1021 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1022 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1023 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1024 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1025 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1026 "heightType": "A String", # Specifies how the height is measured. 1027 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1028 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1029 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1030 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1031 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1032 }, 1033 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1034 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1035 "A String", 1036 ], 1037 "model": { # Information about the model of the device. # Information about this device model. 1038 "firmwareVersion": "A String", # The firmware version of the device. 1039 "hardwareVersion": "A String", # The hardware version of the device. 1040 "name": "A String", # The name of the device model. 1041 "softwareVersion": "A String", # The software version of the device. 1042 "vendor": "A String", # The name of the device vendor. 1043 }, 1044 "state": "A String", # State of the configuration. 1045 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1046 "userId": "A String", # The identifier of a device user. 1047 }, 1048 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 1049 "state": "A String", # Output only. Device state. 1050} 1051 1052 updateMask: string, Fields to be updated. 1053 x__xgafv: string, V1 error format. 1054 Allowed values 1055 1 - v1 error format 1056 2 - v2 error format 1057 1058Returns: 1059 An object of the form: 1060 1061 { 1062 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 1063 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1064 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1065 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1066 }, 1067 "callSign": "A String", # The call sign of the device operator. 1068 "category": "A String", # FCC category of the device. 1069 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1070 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1071 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1072 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1073 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1074 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1075 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1076 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1077 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1078 "heightType": "A String", # Specifies how the height is measured. 1079 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1080 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1081 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1082 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1083 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1084 }, 1085 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1086 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1087 "A String", 1088 ], 1089 "model": { # Information about the model of the device. # Information about this device model. 1090 "firmwareVersion": "A String", # The firmware version of the device. 1091 "hardwareVersion": "A String", # The hardware version of the device. 1092 "name": "A String", # The name of the device model. 1093 "softwareVersion": "A String", # The software version of the device. 1094 "vendor": "A String", # The name of the device vendor. 1095 }, 1096 "state": "A String", # State of the configuration. 1097 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1098 "userId": "A String", # The identifier of a device user. 1099 }, 1100 "currentChannels": [ # Output only. Current channels with scores. 1101 { # The channel with score. 1102 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 1103 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1104 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1105 }, 1106 "score": 3.14, # The channel score, normalized to be in [0,100]. 1107 }, 1108 ], 1109 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 1110 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 1111 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 1112 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 1113 }, 1114 "displayName": "A String", # Device display name. 1115 "fccId": "A String", # The FCC identifier of the device. 1116 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 1117 { # Frequency range from `low_frequency` to `high_frequency`. 1118 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1119 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1120 }, 1121 ], 1122 "grants": [ # Output only. Grants held by the device. 1123 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 1124 "channelType": "A String", # Type of channel used. 1125 "expireTime": "A String", # The expiration time of the grant. 1126 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 1127 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1128 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1129 }, 1130 "grantId": "A String", # Grant Id. 1131 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 1132 "moveList": [ # The DPA move lists on which this grant appears. 1133 { # An entry in a DPA's move list. 1134 "dpaId": "A String", # The ID of the DPA. 1135 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 1136 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1137 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1138 }, 1139 }, 1140 ], 1141 "state": "A String", # State of the grant. 1142 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 1143 "A String", 1144 ], 1145 }, 1146 ], 1147 "name": "A String", # Output only. The resource path name. 1148 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 1149 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1150 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1151 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1152 }, 1153 "callSign": "A String", # The call sign of the device operator. 1154 "category": "A String", # FCC category of the device. 1155 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1156 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1157 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1158 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1159 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1160 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1161 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1162 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1163 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1164 "heightType": "A String", # Specifies how the height is measured. 1165 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1166 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1167 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1168 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1169 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1170 }, 1171 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1172 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1173 "A String", 1174 ], 1175 "model": { # Information about the model of the device. # Information about this device model. 1176 "firmwareVersion": "A String", # The firmware version of the device. 1177 "hardwareVersion": "A String", # The hardware version of the device. 1178 "name": "A String", # The name of the device model. 1179 "softwareVersion": "A String", # The software version of the device. 1180 "vendor": "A String", # The name of the device vendor. 1181 }, 1182 "state": "A String", # State of the configuration. 1183 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1184 "userId": "A String", # The identifier of a device user. 1185 }, 1186 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 1187 "state": "A String", # Output only. Device state. 1188}</pre> 1189</div> 1190 1191<div class="method"> 1192 <code class="details" id="signDevice">signDevice(name, body=None, x__xgafv=None)</code> 1193 <pre>Signs a device. 1194 1195Args: 1196 name: string, Output only. The resource path name. (required) 1197 body: object, The request body. 1198 The object takes the form of: 1199 1200{ # Request for SignDevice. 1201 "device": { # Required. The device to sign. The device fields name, fcc_id and serial_number must be set. The user_id field must be set. 1202 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 1203 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1204 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1205 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1206 }, 1207 "callSign": "A String", # The call sign of the device operator. 1208 "category": "A String", # FCC category of the device. 1209 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1210 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1211 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1212 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1213 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1214 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1215 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1216 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1217 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1218 "heightType": "A String", # Specifies how the height is measured. 1219 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1220 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1221 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1222 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1223 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1224 }, 1225 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1226 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1227 "A String", 1228 ], 1229 "model": { # Information about the model of the device. # Information about this device model. 1230 "firmwareVersion": "A String", # The firmware version of the device. 1231 "hardwareVersion": "A String", # The hardware version of the device. 1232 "name": "A String", # The name of the device model. 1233 "softwareVersion": "A String", # The software version of the device. 1234 "vendor": "A String", # The name of the device vendor. 1235 }, 1236 "state": "A String", # State of the configuration. 1237 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1238 "userId": "A String", # The identifier of a device user. 1239 }, 1240 "currentChannels": [ # Output only. Current channels with scores. 1241 { # The channel with score. 1242 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 1243 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1244 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1245 }, 1246 "score": 3.14, # The channel score, normalized to be in [0,100]. 1247 }, 1248 ], 1249 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 1250 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 1251 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 1252 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 1253 }, 1254 "displayName": "A String", # Device display name. 1255 "fccId": "A String", # The FCC identifier of the device. 1256 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 1257 { # Frequency range from `low_frequency` to `high_frequency`. 1258 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1259 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1260 }, 1261 ], 1262 "grants": [ # Output only. Grants held by the device. 1263 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 1264 "channelType": "A String", # Type of channel used. 1265 "expireTime": "A String", # The expiration time of the grant. 1266 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 1267 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1268 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1269 }, 1270 "grantId": "A String", # Grant Id. 1271 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 1272 "moveList": [ # The DPA move lists on which this grant appears. 1273 { # An entry in a DPA's move list. 1274 "dpaId": "A String", # The ID of the DPA. 1275 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 1276 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1277 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1278 }, 1279 }, 1280 ], 1281 "state": "A String", # State of the grant. 1282 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 1283 "A String", 1284 ], 1285 }, 1286 ], 1287 "name": "A String", # Output only. The resource path name. 1288 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 1289 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1290 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1291 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1292 }, 1293 "callSign": "A String", # The call sign of the device operator. 1294 "category": "A String", # FCC category of the device. 1295 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1296 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1297 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1298 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1299 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1300 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1301 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1302 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1303 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1304 "heightType": "A String", # Specifies how the height is measured. 1305 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1306 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1307 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1308 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1309 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1310 }, 1311 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1312 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1313 "A String", 1314 ], 1315 "model": { # Information about the model of the device. # Information about this device model. 1316 "firmwareVersion": "A String", # The firmware version of the device. 1317 "hardwareVersion": "A String", # The hardware version of the device. 1318 "name": "A String", # The name of the device model. 1319 "softwareVersion": "A String", # The software version of the device. 1320 "vendor": "A String", # The name of the device vendor. 1321 }, 1322 "state": "A String", # State of the configuration. 1323 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1324 "userId": "A String", # The identifier of a device user. 1325 }, 1326 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 1327 "state": "A String", # Output only. Device state. 1328 }, 1329} 1330 1331 x__xgafv: string, V1 error format. 1332 Allowed values 1333 1 - v1 error format 1334 2 - v2 error format 1335 1336Returns: 1337 An object of the form: 1338 1339 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 1340}</pre> 1341</div> 1342 1343<div class="method"> 1344 <code class="details" id="updateSigned">updateSigned(name, body=None, x__xgafv=None)</code> 1345 <pre>Updates a signed device. 1346 1347Args: 1348 name: string, Required. The name of the device to update. (required) 1349 body: object, The request body. 1350 The object takes the form of: 1351 1352{ # Request for UpdateSignedDevice. 1353 "encodedDevice": "A String", # Required. The JSON Web Token signed using a CPI private key. Payload must be the JSON encoding of the device. The user_id field must be set. 1354 "installerId": "A String", # Required. Unique installer ID (CPI ID) from the Certified Professional Installers database. 1355} 1356 1357 x__xgafv: string, V1 error format. 1358 Allowed values 1359 1 - v1 error format 1360 2 - v2 error format 1361 1362Returns: 1363 An object of the form: 1364 1365 { 1366 "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. 1367 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1368 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1369 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1370 }, 1371 "callSign": "A String", # The call sign of the device operator. 1372 "category": "A String", # FCC category of the device. 1373 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1374 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1375 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1376 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1377 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1378 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1379 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1380 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1381 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1382 "heightType": "A String", # Specifies how the height is measured. 1383 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1384 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1385 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1386 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1387 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1388 }, 1389 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1390 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1391 "A String", 1392 ], 1393 "model": { # Information about the model of the device. # Information about this device model. 1394 "firmwareVersion": "A String", # The firmware version of the device. 1395 "hardwareVersion": "A String", # The hardware version of the device. 1396 "name": "A String", # The name of the device model. 1397 "softwareVersion": "A String", # The software version of the device. 1398 "vendor": "A String", # The name of the device vendor. 1399 }, 1400 "state": "A String", # State of the configuration. 1401 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1402 "userId": "A String", # The identifier of a device user. 1403 }, 1404 "currentChannels": [ # Output only. Current channels with scores. 1405 { # The channel with score. 1406 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. 1407 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1408 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1409 }, 1410 "score": 3.14, # The channel score, normalized to be in [0,100]. 1411 }, 1412 ], 1413 "deviceMetadata": { # Device data overridable by both SAS Portal and registration requests. # Device parameters that can be overridden by both SAS Portal and SAS registration requests. 1414 "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId 1415 "commonChannelGroup": "A String", # CCG. A group of CBSDs in the same ICG requesting a common primary channel assignment. See CBRSA-TS-2001 V3.0.0 for more details. 1416 "interferenceCoordinationGroup": "A String", # ICG. A group of CBSDs that manage their own interference with the group. See CBRSA-TS-2001 V3.0.0 for more details. 1417 }, 1418 "displayName": "A String", # Device display name. 1419 "fccId": "A String", # The FCC identifier of the device. 1420 "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. 1421 { # Frequency range from `low_frequency` to `high_frequency`. 1422 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1423 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1424 }, 1425 ], 1426 "grants": [ # Output only. Grants held by the device. 1427 { # Device grant. It is an authorization provided by the Spectrum Access System to a device to transmit using specified operating parameters after a successful heartbeat by the device. 1428 "channelType": "A String", # Type of channel used. 1429 "expireTime": "A String", # The expiration time of the grant. 1430 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. 1431 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1432 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1433 }, 1434 "grantId": "A String", # Grant Id. 1435 "maxEirp": 3.14, # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. The maximum EIRP is in units of dBm/MHz. The value of `maxEirp` represents the average (RMS) EIRP that would be measured by the procedure defined in FCC part 96.41(e)(3). 1436 "moveList": [ # The DPA move lists on which this grant appears. 1437 { # An entry in a DPA's move list. 1438 "dpaId": "A String", # The ID of the DPA. 1439 "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. 1440 "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. 1441 "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. 1442 }, 1443 }, 1444 ], 1445 "state": "A String", # State of the grant. 1446 "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. 1447 "A String", 1448 ], 1449 }, 1450 ], 1451 "name": "A String", # Output only. The resource path name. 1452 "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. 1453 "airInterface": { # Information about the device's air interface. # Information about this device's air interface. 1454 "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. 1455 "supportedSpec": "A String", # Optional. This field is related to the `radioTechnology` and provides the air interface specification that the CBSD is compliant with at the time of registration. 1456 }, 1457 "callSign": "A String", # The call sign of the device operator. 1458 "category": "A String", # FCC category of the device. 1459 "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. 1460 "antennaAzimuth": 42, # Boresight direction of the horizontal plane of the antenna in degrees with respect to true north. The value of this parameter is an integer with a value between 0 and 359 inclusive. A value of 0 degrees means true north; a value of 90 degrees means east. This parameter is optional for Category A devices and conditional for Category B devices. 1461 "antennaBeamwidth": 42, # 3-dB antenna beamwidth of the antenna in the horizontal-plane in degrees. This parameter is an unsigned integer having a value between 0 and 360 (degrees) inclusive; it is optional for Category A devices and conditional for Category B devices. 1462 "antennaDowntilt": 42, # Antenna downtilt in degrees and is an integer with a value between -90 and +90 inclusive; a negative value means the antenna is tilted up (above horizontal). This parameter is optional for Category A devices and conditional for Category B devices. 1463 "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. 1464 "antennaModel": "A String", # If an external antenna is used, the antenna model is optionally provided in this field. The string has a maximum length of 128 octets. 1465 "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. 1466 "eirpCapability": 42, # This parameter is the maximum device EIRP in units of dBm/10MHz and is an integer with a value between -127 and +47 (dBm/10 MHz) inclusive. If not included, SAS interprets it as maximum allowable EIRP in units of dBm/10MHz for device category. 1467 "height": 3.14, # Device antenna height in meters. When the `heightType` parameter value is "AGL", the antenna height should be given relative to ground level. When the `heightType` parameter value is "AMSL", it is given with respect to WGS84 datum. 1468 "heightType": "A String", # Specifies how the height is measured. 1469 "horizontalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna horizontal location. This optional parameter should only be present if its value is less than the FCC requirement of 50 meters. 1470 "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. 1471 "latitude": 3.14, # Latitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -90.000000 to +90.000000. Positive values represent latitudes north of the equator; negative values south of the equator. 1472 "longitude": 3.14, # Longitude of the device antenna location in degrees relative to the WGS 84 datum. The allowed range is from -180.000000 to +180.000000. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian. 1473 "verticalAccuracy": 3.14, # A positive number in meters to indicate accuracy of the device antenna vertical location. This optional parameter should only be present if its value is less than the FCC requirement of 3 meters. 1474 }, 1475 "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. 1476 "measurementCapabilities": [ # Measurement reporting capabilities of the device. 1477 "A String", 1478 ], 1479 "model": { # Information about the model of the device. # Information about this device model. 1480 "firmwareVersion": "A String", # The firmware version of the device. 1481 "hardwareVersion": "A String", # The hardware version of the device. 1482 "name": "A String", # The name of the device model. 1483 "softwareVersion": "A String", # The software version of the device. 1484 "vendor": "A String", # The name of the device vendor. 1485 }, 1486 "state": "A String", # State of the configuration. 1487 "updateTime": "A String", # Output only. The last time the device configuration was edited. 1488 "userId": "A String", # The identifier of a device user. 1489 }, 1490 "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. 1491 "state": "A String", # Output only. Device state. 1492}</pre> 1493</div> 1494 1495</body></html>