| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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="prod_tt_sasportal_v1alpha1.html">SAS Portal API (Testing)</a> . <a href="prod_tt_sasportal_v1alpha1.customers.html">customers</a> . <a href="prod_tt_sasportal_v1alpha1.customers.devices.html">devices</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 85 | <p class="firstline">Creates a signed device under a node or customer.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 93 | <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 112 | <code class="details" id="close">close()</code> |
| 113 | <pre>Close httplib2 connections.</pre> |
| 114 | </div> |
| 115 | |
| 116 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 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 | |
| 120 | Args: |
| 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 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 130 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 144 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 149 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 150 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 151 | "A String", |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 152 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 161 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 162 | "userId": "A String", # The identifier of a device user. |
| 163 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 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 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 174 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 175 | }, |
| 176 | "displayName": "A String", # Device display name. |
| 177 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 178 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 179 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 180 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 181 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 182 | }, |
| 183 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 184 | "grants": [ # Output only. Grants held by the device. |
| 185 | { # 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. |
| 186 | "channelType": "A String", # Type of channel used. |
| 187 | "expireTime": "A String", # The expiration time of the grant. |
| 188 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 189 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 190 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 191 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 192 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 193 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 194 | "moveList": [ # The DPA move lists on which this grant appears. |
| 195 | { # An entry in a DPA's move list. |
| 196 | "dpaId": "A String", # The ID of the DPA. |
| 197 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 198 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 199 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 200 | }, |
| 201 | }, |
| 202 | ], |
| 203 | "state": "A String", # State of the grant. |
| 204 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 205 | "A String", |
| 206 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 207 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 208 | ], |
| 209 | "name": "A String", # Output only. The resource path name. |
| 210 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 211 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 212 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 213 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 214 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 215 | "callSign": "A String", # The call sign of the device operator. |
| 216 | "category": "A String", # FCC category of the device. |
| 217 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 218 | "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. |
| 219 | "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. |
| 220 | "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. |
| 221 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 222 | "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. |
| 223 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 224 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 225 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 226 | "heightType": "A String", # Specifies how the height is measured. |
| 227 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 228 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 229 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 230 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 231 | "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. |
| 232 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 233 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 234 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 235 | "A String", |
| 236 | ], |
| 237 | "model": { # Information about the model of the device. # Information about this device model. |
| 238 | "firmwareVersion": "A String", # The firmware version of the device. |
| 239 | "hardwareVersion": "A String", # The hardware version of the device. |
| 240 | "name": "A String", # The name of the device model. |
| 241 | "softwareVersion": "A String", # The software version of the device. |
| 242 | "vendor": "A String", # The name of the device vendor. |
| 243 | }, |
| 244 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 245 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 246 | "userId": "A String", # The identifier of a device user. |
| 247 | }, |
| 248 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 249 | "state": "A String", # Output only. Device state. |
| 250 | } |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 251 | |
| 252 | x__xgafv: string, V1 error format. |
| 253 | Allowed values |
| 254 | 1 - v1 error format |
| 255 | 2 - v2 error format |
| 256 | |
| 257 | Returns: |
| 258 | An object of the form: |
| 259 | |
| 260 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 261 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 262 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 263 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 264 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 265 | }, |
| 266 | "callSign": "A String", # The call sign of the device operator. |
| 267 | "category": "A String", # FCC category of the device. |
| 268 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 269 | "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. |
| 270 | "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. |
| 271 | "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. |
| 272 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 273 | "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. |
| 274 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 275 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 276 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 277 | "heightType": "A String", # Specifies how the height is measured. |
| 278 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 279 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 280 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 281 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 282 | "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. |
| 283 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 284 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 285 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 286 | "A String", |
| 287 | ], |
| 288 | "model": { # Information about the model of the device. # Information about this device model. |
| 289 | "firmwareVersion": "A String", # The firmware version of the device. |
| 290 | "hardwareVersion": "A String", # The hardware version of the device. |
| 291 | "name": "A String", # The name of the device model. |
| 292 | "softwareVersion": "A String", # The software version of the device. |
| 293 | "vendor": "A String", # The name of the device vendor. |
| 294 | }, |
| 295 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 296 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 297 | "userId": "A String", # The identifier of a device user. |
| 298 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 299 | "currentChannels": [ # Output only. Current channels with scores. |
| 300 | { # The channel with score. |
| 301 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 302 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 303 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 304 | }, |
| 305 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 306 | }, |
| 307 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 308 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 309 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 310 | }, |
| 311 | "displayName": "A String", # Device display name. |
| 312 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 313 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 314 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 315 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 316 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 317 | }, |
| 318 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 319 | "grants": [ # Output only. Grants held by the device. |
| 320 | { # 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. |
| 321 | "channelType": "A String", # Type of channel used. |
| 322 | "expireTime": "A String", # The expiration time of the grant. |
| 323 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 324 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 325 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 326 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 327 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 328 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 329 | "moveList": [ # The DPA move lists on which this grant appears. |
| 330 | { # An entry in a DPA's move list. |
| 331 | "dpaId": "A String", # The ID of the DPA. |
| 332 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 333 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 334 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 335 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 336 | }, |
| 337 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 338 | "state": "A String", # State of the grant. |
| 339 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 340 | "A String", |
| 341 | ], |
| 342 | }, |
| 343 | ], |
| 344 | "name": "A String", # Output only. The resource path name. |
| 345 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 346 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 347 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 348 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 349 | }, |
| 350 | "callSign": "A String", # The call sign of the device operator. |
| 351 | "category": "A String", # FCC category of the device. |
| 352 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 353 | "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. |
| 354 | "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. |
| 355 | "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. |
| 356 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 357 | "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. |
| 358 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 359 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 360 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 361 | "heightType": "A String", # Specifies how the height is measured. |
| 362 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 363 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 364 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 365 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 366 | "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. |
| 367 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 368 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 369 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 370 | "A String", |
| 371 | ], |
| 372 | "model": { # Information about the model of the device. # Information about this device model. |
| 373 | "firmwareVersion": "A String", # The firmware version of the device. |
| 374 | "hardwareVersion": "A String", # The hardware version of the device. |
| 375 | "name": "A String", # The name of the device model. |
| 376 | "softwareVersion": "A String", # The software version of the device. |
| 377 | "vendor": "A String", # The name of the device vendor. |
| 378 | }, |
| 379 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 380 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 381 | "userId": "A String", # The identifier of a device user. |
| 382 | }, |
| 383 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 384 | "state": "A String", # Output only. Device state. |
| 385 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | </div> |
| 387 | |
| 388 | <div class="method"> |
| 389 | <code class="details" id="createSigned">createSigned(parent, body=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 390 | <pre>Creates a signed device under a node or customer. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 391 | |
| 392 | Args: |
| 393 | parent: string, Required. The name of the parent resource. (required) |
| 394 | body: object, The request body. |
| 395 | The object takes the form of: |
| 396 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 397 | { # Request for CreateSignedDevice. |
| 398 | "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. |
| 399 | "installerId": "A String", # Required. Unique installer id (CPI ID) from the Certified Professional Installers database. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 400 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 401 | |
| 402 | x__xgafv: string, V1 error format. |
| 403 | Allowed values |
| 404 | 1 - v1 error format |
| 405 | 2 - v2 error format |
| 406 | |
| 407 | Returns: |
| 408 | An object of the form: |
| 409 | |
| 410 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 411 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 412 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 413 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 414 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 415 | }, |
| 416 | "callSign": "A String", # The call sign of the device operator. |
| 417 | "category": "A String", # FCC category of the device. |
| 418 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 419 | "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. |
| 420 | "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. |
| 421 | "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. |
| 422 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 423 | "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. |
| 424 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 425 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 426 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 427 | "heightType": "A String", # Specifies how the height is measured. |
| 428 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 429 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 430 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 431 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 432 | "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. |
| 433 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 434 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 435 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 436 | "A String", |
| 437 | ], |
| 438 | "model": { # Information about the model of the device. # Information about this device model. |
| 439 | "firmwareVersion": "A String", # The firmware version of the device. |
| 440 | "hardwareVersion": "A String", # The hardware version of the device. |
| 441 | "name": "A String", # The name of the device model. |
| 442 | "softwareVersion": "A String", # The software version of the device. |
| 443 | "vendor": "A String", # The name of the device vendor. |
| 444 | }, |
| 445 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 446 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 447 | "userId": "A String", # The identifier of a device user. |
| 448 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 449 | "currentChannels": [ # Output only. Current channels with scores. |
| 450 | { # The channel with score. |
| 451 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 452 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 453 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 454 | }, |
| 455 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 456 | }, |
| 457 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 458 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 459 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 460 | }, |
| 461 | "displayName": "A String", # Device display name. |
| 462 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 463 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 464 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 465 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 466 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 467 | }, |
| 468 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 469 | "grants": [ # Output only. Grants held by the device. |
| 470 | { # 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. |
| 471 | "channelType": "A String", # Type of channel used. |
| 472 | "expireTime": "A String", # The expiration time of the grant. |
| 473 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 474 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 475 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 476 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 477 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 478 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 479 | "moveList": [ # The DPA move lists on which this grant appears. |
| 480 | { # An entry in a DPA's move list. |
| 481 | "dpaId": "A String", # The ID of the DPA. |
| 482 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 483 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 484 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 485 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 486 | }, |
| 487 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 488 | "state": "A String", # State of the grant. |
| 489 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 490 | "A String", |
| 491 | ], |
| 492 | }, |
| 493 | ], |
| 494 | "name": "A String", # Output only. The resource path name. |
| 495 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 496 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 497 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 498 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 499 | }, |
| 500 | "callSign": "A String", # The call sign of the device operator. |
| 501 | "category": "A String", # FCC category of the device. |
| 502 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 503 | "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. |
| 504 | "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. |
| 505 | "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. |
| 506 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 507 | "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. |
| 508 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 509 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 510 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 511 | "heightType": "A String", # Specifies how the height is measured. |
| 512 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 513 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 514 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 515 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 516 | "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. |
| 517 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 518 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 519 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 520 | "A String", |
| 521 | ], |
| 522 | "model": { # Information about the model of the device. # Information about this device model. |
| 523 | "firmwareVersion": "A String", # The firmware version of the device. |
| 524 | "hardwareVersion": "A String", # The hardware version of the device. |
| 525 | "name": "A String", # The name of the device model. |
| 526 | "softwareVersion": "A String", # The software version of the device. |
| 527 | "vendor": "A String", # The name of the device vendor. |
| 528 | }, |
| 529 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 530 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 531 | "userId": "A String", # The identifier of a device user. |
| 532 | }, |
| 533 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 534 | "state": "A String", # Output only. Device state. |
| 535 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 536 | </div> |
| 537 | |
| 538 | <div class="method"> |
| 539 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 540 | <pre>Deletes a device. |
| 541 | |
| 542 | Args: |
| 543 | name: string, Required. The name of the device. (required) |
| 544 | x__xgafv: string, V1 error format. |
| 545 | Allowed values |
| 546 | 1 - v1 error format |
| 547 | 2 - v2 error format |
| 548 | |
| 549 | Returns: |
| 550 | An object of the form: |
| 551 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 552 | { # 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 `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 553 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 554 | </div> |
| 555 | |
| 556 | <div class="method"> |
| 557 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 558 | <pre>Gets details about a device. |
| 559 | |
| 560 | Args: |
| 561 | name: string, Required. The name of the device. (required) |
| 562 | x__xgafv: string, V1 error format. |
| 563 | Allowed values |
| 564 | 1 - v1 error format |
| 565 | 2 - v2 error format |
| 566 | |
| 567 | Returns: |
| 568 | An object of the form: |
| 569 | |
| 570 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 571 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 572 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 573 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 574 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 575 | }, |
| 576 | "callSign": "A String", # The call sign of the device operator. |
| 577 | "category": "A String", # FCC category of the device. |
| 578 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 579 | "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. |
| 580 | "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. |
| 581 | "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. |
| 582 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 583 | "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. |
| 584 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 585 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 586 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 587 | "heightType": "A String", # Specifies how the height is measured. |
| 588 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 589 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 590 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 591 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 592 | "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. |
| 593 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 594 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 595 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 596 | "A String", |
| 597 | ], |
| 598 | "model": { # Information about the model of the device. # Information about this device model. |
| 599 | "firmwareVersion": "A String", # The firmware version of the device. |
| 600 | "hardwareVersion": "A String", # The hardware version of the device. |
| 601 | "name": "A String", # The name of the device model. |
| 602 | "softwareVersion": "A String", # The software version of the device. |
| 603 | "vendor": "A String", # The name of the device vendor. |
| 604 | }, |
| 605 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 606 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 607 | "userId": "A String", # The identifier of a device user. |
| 608 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 609 | "currentChannels": [ # Output only. Current channels with scores. |
| 610 | { # The channel with score. |
| 611 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 612 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 613 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 614 | }, |
| 615 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 616 | }, |
| 617 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 618 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 619 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 620 | }, |
| 621 | "displayName": "A String", # Device display name. |
| 622 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 623 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 624 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 625 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 626 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 627 | }, |
| 628 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 629 | "grants": [ # Output only. Grants held by the device. |
| 630 | { # 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. |
| 631 | "channelType": "A String", # Type of channel used. |
| 632 | "expireTime": "A String", # The expiration time of the grant. |
| 633 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 634 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 635 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 636 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 637 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 638 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 639 | "moveList": [ # The DPA move lists on which this grant appears. |
| 640 | { # An entry in a DPA's move list. |
| 641 | "dpaId": "A String", # The ID of the DPA. |
| 642 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 643 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 644 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 645 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 646 | }, |
| 647 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 648 | "state": "A String", # State of the grant. |
| 649 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 650 | "A String", |
| 651 | ], |
| 652 | }, |
| 653 | ], |
| 654 | "name": "A String", # Output only. The resource path name. |
| 655 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 656 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 657 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 658 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 659 | }, |
| 660 | "callSign": "A String", # The call sign of the device operator. |
| 661 | "category": "A String", # FCC category of the device. |
| 662 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 663 | "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. |
| 664 | "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. |
| 665 | "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. |
| 666 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 667 | "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. |
| 668 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 669 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 670 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 671 | "heightType": "A String", # Specifies how the height is measured. |
| 672 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 673 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 674 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 675 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 676 | "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. |
| 677 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 678 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 679 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 680 | "A String", |
| 681 | ], |
| 682 | "model": { # Information about the model of the device. # Information about this device model. |
| 683 | "firmwareVersion": "A String", # The firmware version of the device. |
| 684 | "hardwareVersion": "A String", # The hardware version of the device. |
| 685 | "name": "A String", # The name of the device model. |
| 686 | "softwareVersion": "A String", # The software version of the device. |
| 687 | "vendor": "A String", # The name of the device vendor. |
| 688 | }, |
| 689 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 690 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 691 | "userId": "A String", # The identifier of a device user. |
| 692 | }, |
| 693 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 694 | "state": "A String", # Output only. Device state. |
| 695 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 696 | </div> |
| 697 | |
| 698 | <div class="method"> |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 699 | <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 700 | <pre>Lists devices under a node or customer. |
| 701 | |
| 702 | Args: |
| 703 | parent: string, Required. The name of the parent resource. (required) |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 704 | 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. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 705 | 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]. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 706 | pageToken: string, A pagination token returned from a previous call to ListDevices that indicates where this listing should continue from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 707 | x__xgafv: string, V1 error format. |
| 708 | Allowed values |
| 709 | 1 - v1 error format |
| 710 | 2 - v2 error format |
| 711 | |
| 712 | Returns: |
| 713 | An object of the form: |
| 714 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 715 | { # Response for ListDevices. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 716 | "devices": [ # The devices that match the request. |
| 717 | { |
| 718 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 719 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 720 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 721 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 722 | }, |
| 723 | "callSign": "A String", # The call sign of the device operator. |
| 724 | "category": "A String", # FCC category of the device. |
| 725 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 726 | "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. |
| 727 | "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. |
| 728 | "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. |
| 729 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 730 | "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. |
| 731 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 732 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 733 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 734 | "heightType": "A String", # Specifies how the height is measured. |
| 735 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 736 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 737 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 738 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 739 | "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. |
| 740 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 741 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 742 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 743 | "A String", |
| 744 | ], |
| 745 | "model": { # Information about the model of the device. # Information about this device model. |
| 746 | "firmwareVersion": "A String", # The firmware version of the device. |
| 747 | "hardwareVersion": "A String", # The hardware version of the device. |
| 748 | "name": "A String", # The name of the device model. |
| 749 | "softwareVersion": "A String", # The software version of the device. |
| 750 | "vendor": "A String", # The name of the device vendor. |
| 751 | }, |
| 752 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 753 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 754 | "userId": "A String", # The identifier of a device user. |
| 755 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 756 | "currentChannels": [ # Output only. Current channels with scores. |
| 757 | { # The channel with score. |
| 758 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 759 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 760 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 761 | }, |
| 762 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 763 | }, |
| 764 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 765 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 766 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 767 | }, |
| 768 | "displayName": "A String", # Device display name. |
| 769 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 770 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 771 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 772 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 773 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 774 | }, |
| 775 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 776 | "grants": [ # Output only. Grants held by the device. |
| 777 | { # 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. |
| 778 | "channelType": "A String", # Type of channel used. |
| 779 | "expireTime": "A String", # The expiration time of the grant. |
| 780 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 781 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 782 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 783 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 784 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 785 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 786 | "moveList": [ # The DPA move lists on which this grant appears. |
| 787 | { # An entry in a DPA's move list. |
| 788 | "dpaId": "A String", # The ID of the DPA. |
| 789 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 790 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 791 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 792 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 793 | }, |
| 794 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 795 | "state": "A String", # State of the grant. |
| 796 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 797 | "A String", |
| 798 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 799 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 800 | ], |
| 801 | "name": "A String", # Output only. The resource path name. |
| 802 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 803 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 804 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 805 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 806 | }, |
| 807 | "callSign": "A String", # The call sign of the device operator. |
| 808 | "category": "A String", # FCC category of the device. |
| 809 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 810 | "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. |
| 811 | "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. |
| 812 | "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. |
| 813 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 814 | "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. |
| 815 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 816 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 817 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 818 | "heightType": "A String", # Specifies how the height is measured. |
| 819 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 820 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 821 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 822 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 823 | "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. |
| 824 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 825 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 826 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 827 | "A String", |
| 828 | ], |
| 829 | "model": { # Information about the model of the device. # Information about this device model. |
| 830 | "firmwareVersion": "A String", # The firmware version of the device. |
| 831 | "hardwareVersion": "A String", # The hardware version of the device. |
| 832 | "name": "A String", # The name of the device model. |
| 833 | "softwareVersion": "A String", # The software version of the device. |
| 834 | "vendor": "A String", # The name of the device vendor. |
| 835 | }, |
| 836 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 837 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 838 | "userId": "A String", # The identifier of a device user. |
| 839 | }, |
| 840 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 841 | "state": "A String", # Output only. Device state. |
| 842 | }, |
| 843 | ], |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 844 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 845 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 846 | </div> |
| 847 | |
| 848 | <div class="method"> |
| 849 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 850 | <pre>Retrieves the next page of results. |
| 851 | |
| 852 | Args: |
| 853 | previous_request: The request for the previous page. (required) |
| 854 | previous_response: The response from the request for the previous page. (required) |
| 855 | |
| 856 | Returns: |
| 857 | A request object that you can call 'execute()' on to request the next |
| 858 | page. Returns None if there are no more items in the collection. |
| 859 | </pre> |
| 860 | </div> |
| 861 | |
| 862 | <div class="method"> |
| 863 | <code class="details" id="move">move(name, body=None, x__xgafv=None)</code> |
| 864 | <pre>Moves a device under another node or customer. |
| 865 | |
| 866 | Args: |
| 867 | name: string, Required. The name of the device to move. (required) |
| 868 | body: object, The request body. |
| 869 | The object takes the form of: |
| 870 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 871 | { # Request for MoveDevice. |
| 872 | "destination": "A String", # Required. The name of the new parent resource node or customer to reparent the device under. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 873 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 874 | |
| 875 | x__xgafv: string, V1 error format. |
| 876 | Allowed values |
| 877 | 1 - v1 error format |
| 878 | 2 - v2 error format |
| 879 | |
| 880 | Returns: |
| 881 | An object of the form: |
| 882 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 883 | { # This resource represents a long-running operation that is the result of a network API call. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 884 | "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. |
| 885 | "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. |
| 886 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 887 | "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 888 | { |
| 889 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 890 | }, |
| 891 | ], |
| 892 | "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. |
| 893 | }, |
| 894 | "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. |
| 895 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 896 | }, |
| 897 | "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}`. |
| 898 | "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`. |
| 899 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 900 | }, |
| 901 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 902 | </div> |
| 903 | |
| 904 | <div class="method"> |
| 905 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 906 | <pre>Updates a device. |
| 907 | |
| 908 | Args: |
| 909 | name: string, Output only. The resource path name. (required) |
| 910 | body: object, The request body. |
| 911 | The object takes the form of: |
| 912 | |
| 913 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 914 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 915 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 916 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 917 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 918 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 919 | "callSign": "A String", # The call sign of the device operator. |
| 920 | "category": "A String", # FCC category of the device. |
| 921 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 922 | "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. |
| 923 | "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. |
| 924 | "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. |
| 925 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 926 | "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. |
| 927 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 928 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 929 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 930 | "heightType": "A String", # Specifies how the height is measured. |
| 931 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 932 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 933 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 934 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 935 | "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. |
| 936 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 937 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 938 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 939 | "A String", |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 940 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 941 | "model": { # Information about the model of the device. # Information about this device model. |
| 942 | "firmwareVersion": "A String", # The firmware version of the device. |
| 943 | "hardwareVersion": "A String", # The hardware version of the device. |
| 944 | "name": "A String", # The name of the device model. |
| 945 | "softwareVersion": "A String", # The software version of the device. |
| 946 | "vendor": "A String", # The name of the device vendor. |
| 947 | }, |
| 948 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 949 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 950 | "userId": "A String", # The identifier of a device user. |
| 951 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 952 | "currentChannels": [ # Output only. Current channels with scores. |
| 953 | { # The channel with score. |
| 954 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 955 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 956 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 957 | }, |
| 958 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 959 | }, |
| 960 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 961 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 962 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 963 | }, |
| 964 | "displayName": "A String", # Device display name. |
| 965 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 966 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 967 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 968 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 969 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 970 | }, |
| 971 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 972 | "grants": [ # Output only. Grants held by the device. |
| 973 | { # 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. |
| 974 | "channelType": "A String", # Type of channel used. |
| 975 | "expireTime": "A String", # The expiration time of the grant. |
| 976 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 977 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 978 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 979 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 980 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 981 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 982 | "moveList": [ # The DPA move lists on which this grant appears. |
| 983 | { # An entry in a DPA's move list. |
| 984 | "dpaId": "A String", # The ID of the DPA. |
| 985 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| 986 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 987 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 988 | }, |
| 989 | }, |
| 990 | ], |
| 991 | "state": "A String", # State of the grant. |
| 992 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 993 | "A String", |
| 994 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 995 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 996 | ], |
| 997 | "name": "A String", # Output only. The resource path name. |
| 998 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 999 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1000 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1001 | "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. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1002 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1003 | "callSign": "A String", # The call sign of the device operator. |
| 1004 | "category": "A String", # FCC category of the device. |
| 1005 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1006 | "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. |
| 1007 | "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. |
| 1008 | "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. |
| 1009 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1010 | "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. |
| 1011 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1012 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1013 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1014 | "heightType": "A String", # Specifies how the height is measured. |
| 1015 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1016 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1017 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1018 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1019 | "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. |
| 1020 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1021 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1022 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1023 | "A String", |
| 1024 | ], |
| 1025 | "model": { # Information about the model of the device. # Information about this device model. |
| 1026 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1027 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1028 | "name": "A String", # The name of the device model. |
| 1029 | "softwareVersion": "A String", # The software version of the device. |
| 1030 | "vendor": "A String", # The name of the device vendor. |
| 1031 | }, |
| 1032 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1033 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1034 | "userId": "A String", # The identifier of a device user. |
| 1035 | }, |
| 1036 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 1037 | "state": "A String", # Output only. Device state. |
| 1038 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1039 | |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1040 | updateMask: string, Fields to be updated. |
| 1041 | x__xgafv: string, V1 error format. |
| 1042 | Allowed values |
| 1043 | 1 - v1 error format |
| 1044 | 2 - v2 error format |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1045 | |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1046 | Returns: |
| 1047 | An object of the form: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1048 | |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1049 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1050 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1051 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1052 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1053 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1054 | }, |
| 1055 | "callSign": "A String", # The call sign of the device operator. |
| 1056 | "category": "A String", # FCC category of the device. |
| 1057 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1058 | "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. |
| 1059 | "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. |
| 1060 | "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. |
| 1061 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1062 | "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. |
| 1063 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1064 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1065 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1066 | "heightType": "A String", # Specifies how the height is measured. |
| 1067 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1068 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1069 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1070 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1071 | "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. |
| 1072 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1073 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1074 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1075 | "A String", |
| 1076 | ], |
| 1077 | "model": { # Information about the model of the device. # Information about this device model. |
| 1078 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1079 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1080 | "name": "A String", # The name of the device model. |
| 1081 | "softwareVersion": "A String", # The software version of the device. |
| 1082 | "vendor": "A String", # The name of the device vendor. |
| 1083 | }, |
| 1084 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1085 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1086 | "userId": "A String", # The identifier of a device user. |
| 1087 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1088 | "currentChannels": [ # Output only. Current channels with scores. |
| 1089 | { # The channel with score. |
| 1090 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 1091 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1092 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1093 | }, |
| 1094 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 1095 | }, |
| 1096 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1097 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1098 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1099 | }, |
| 1100 | "displayName": "A String", # Device display name. |
| 1101 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1102 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 1103 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 1104 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1105 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1106 | }, |
| 1107 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1108 | "grants": [ # Output only. Grants held by the device. |
| 1109 | { # 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. |
| 1110 | "channelType": "A String", # Type of channel used. |
| 1111 | "expireTime": "A String", # The expiration time of the grant. |
| 1112 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1113 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1114 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1115 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1116 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1117 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1118 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1119 | { # An entry in a DPA's move list. |
| 1120 | "dpaId": "A String", # The ID of the DPA. |
| 1121 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1122 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1123 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1124 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1125 | }, |
| 1126 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1127 | "state": "A String", # State of the grant. |
| 1128 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1129 | "A String", |
| 1130 | ], |
| 1131 | }, |
| 1132 | ], |
| 1133 | "name": "A String", # Output only. The resource path name. |
| 1134 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1135 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1136 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1137 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1138 | }, |
| 1139 | "callSign": "A String", # The call sign of the device operator. |
| 1140 | "category": "A String", # FCC category of the device. |
| 1141 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1142 | "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. |
| 1143 | "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. |
| 1144 | "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. |
| 1145 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1146 | "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. |
| 1147 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1148 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1149 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1150 | "heightType": "A String", # Specifies how the height is measured. |
| 1151 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1152 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1153 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1154 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1155 | "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. |
| 1156 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1157 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1158 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1159 | "A String", |
| 1160 | ], |
| 1161 | "model": { # Information about the model of the device. # Information about this device model. |
| 1162 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1163 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1164 | "name": "A String", # The name of the device model. |
| 1165 | "softwareVersion": "A String", # The software version of the device. |
| 1166 | "vendor": "A String", # The name of the device vendor. |
| 1167 | }, |
| 1168 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1169 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1170 | "userId": "A String", # The identifier of a device user. |
| 1171 | }, |
| 1172 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 1173 | "state": "A String", # Output only. Device state. |
| 1174 | }</pre> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1175 | </div> |
| 1176 | |
| 1177 | <div class="method"> |
| 1178 | <code class="details" id="signDevice">signDevice(name, body=None, x__xgafv=None)</code> |
| 1179 | <pre>Signs a device. |
| 1180 | |
| 1181 | Args: |
| 1182 | name: string, Output only. The resource path name. (required) |
| 1183 | body: object, The request body. |
| 1184 | The object takes the form of: |
| 1185 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1186 | { # Request for SignDevice. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1187 | "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. |
| 1188 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1189 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1190 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1191 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1192 | }, |
| 1193 | "callSign": "A String", # The call sign of the device operator. |
| 1194 | "category": "A String", # FCC category of the device. |
| 1195 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1196 | "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. |
| 1197 | "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. |
| 1198 | "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. |
| 1199 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1200 | "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. |
| 1201 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1202 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1203 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1204 | "heightType": "A String", # Specifies how the height is measured. |
| 1205 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1206 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1207 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1208 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1209 | "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. |
| 1210 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1211 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1212 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1213 | "A String", |
| 1214 | ], |
| 1215 | "model": { # Information about the model of the device. # Information about this device model. |
| 1216 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1217 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1218 | "name": "A String", # The name of the device model. |
| 1219 | "softwareVersion": "A String", # The software version of the device. |
| 1220 | "vendor": "A String", # The name of the device vendor. |
| 1221 | }, |
| 1222 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1223 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1224 | "userId": "A String", # The identifier of a device user. |
| 1225 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1226 | "currentChannels": [ # Output only. Current channels with scores. |
| 1227 | { # The channel with score. |
| 1228 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 1229 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1230 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1231 | }, |
| 1232 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 1233 | }, |
| 1234 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1235 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1236 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1237 | }, |
| 1238 | "displayName": "A String", # Device display name. |
| 1239 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1240 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 1241 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 1242 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1243 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1244 | }, |
| 1245 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1246 | "grants": [ # Output only. Grants held by the device. |
| 1247 | { # 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. |
| 1248 | "channelType": "A String", # Type of channel used. |
| 1249 | "expireTime": "A String", # The expiration time of the grant. |
| 1250 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1251 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1252 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1253 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1254 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1255 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1256 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1257 | { # An entry in a DPA's move list. |
| 1258 | "dpaId": "A String", # The ID of the DPA. |
| 1259 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1260 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1261 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1262 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1263 | }, |
| 1264 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1265 | "state": "A String", # State of the grant. |
| 1266 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1267 | "A String", |
| 1268 | ], |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1269 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1270 | ], |
| 1271 | "name": "A String", # Output only. The resource path name. |
| 1272 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1273 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1274 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1275 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1276 | }, |
| 1277 | "callSign": "A String", # The call sign of the device operator. |
| 1278 | "category": "A String", # FCC category of the device. |
| 1279 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1280 | "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. |
| 1281 | "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. |
| 1282 | "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. |
| 1283 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1284 | "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. |
| 1285 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1286 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1287 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1288 | "heightType": "A String", # Specifies how the height is measured. |
| 1289 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1290 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1291 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1292 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1293 | "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. |
| 1294 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1295 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1296 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1297 | "A String", |
| 1298 | ], |
| 1299 | "model": { # Information about the model of the device. # Information about this device model. |
| 1300 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1301 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1302 | "name": "A String", # The name of the device model. |
| 1303 | "softwareVersion": "A String", # The software version of the device. |
| 1304 | "vendor": "A String", # The name of the device vendor. |
| 1305 | }, |
| 1306 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1307 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1308 | "userId": "A String", # The identifier of a device user. |
| 1309 | }, |
| 1310 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 1311 | "state": "A String", # Output only. Device state. |
| 1312 | }, |
| 1313 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1314 | |
| 1315 | x__xgafv: string, V1 error format. |
| 1316 | Allowed values |
| 1317 | 1 - v1 error format |
| 1318 | 2 - v2 error format |
| 1319 | |
| 1320 | Returns: |
| 1321 | An object of the form: |
| 1322 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1323 | { # 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 `{}`. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1324 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1325 | </div> |
| 1326 | |
| 1327 | <div class="method"> |
| 1328 | <code class="details" id="updateSigned">updateSigned(name, body=None, x__xgafv=None)</code> |
| 1329 | <pre>Updates a signed device. |
| 1330 | |
| 1331 | Args: |
| 1332 | name: string, Required. The name of the device to update. (required) |
| 1333 | body: object, The request body. |
| 1334 | The object takes the form of: |
| 1335 | |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1336 | { # Request for UpdateSignedDevice. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1337 | "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. |
| 1338 | "installerId": "A String", # Required. Unique installer ID (CPI ID) from the Certified Professional Installers database. |
| 1339 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1340 | |
| 1341 | x__xgafv: string, V1 error format. |
| 1342 | Allowed values |
| 1343 | 1 - v1 error format |
| 1344 | 2 - v2 error format |
| 1345 | |
| 1346 | Returns: |
| 1347 | An object of the form: |
| 1348 | |
| 1349 | { |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1350 | "activeConfig": { # Information about the device configuration. # Output only. Current configuration of the device as registered to the SAS. |
| 1351 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1352 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1353 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1354 | }, |
| 1355 | "callSign": "A String", # The call sign of the device operator. |
| 1356 | "category": "A String", # FCC category of the device. |
| 1357 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1358 | "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. |
| 1359 | "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. |
| 1360 | "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. |
| 1361 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1362 | "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. |
| 1363 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1364 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1365 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1366 | "heightType": "A String", # Specifies how the height is measured. |
| 1367 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1368 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1369 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1370 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1371 | "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. |
| 1372 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1373 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1374 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1375 | "A String", |
| 1376 | ], |
| 1377 | "model": { # Information about the model of the device. # Information about this device model. |
| 1378 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1379 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1380 | "name": "A String", # The name of the device model. |
| 1381 | "softwareVersion": "A String", # The software version of the device. |
| 1382 | "vendor": "A String", # The name of the device vendor. |
| 1383 | }, |
| 1384 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1385 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1386 | "userId": "A String", # The identifier of a device user. |
| 1387 | }, |
| yoshi-code-bot | a8b35b9 | 2021-03-31 13:33:30 -0700 | [diff] [blame] | 1388 | "currentChannels": [ # Output only. Current channels with scores. |
| 1389 | { # The channel with score. |
| 1390 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range of the channel. |
| 1391 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1392 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1393 | }, |
| 1394 | "score": 3.14, # The channel score, normalized to be in [0,100]. |
| 1395 | }, |
| 1396 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1397 | "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. |
| yoshi-code-bot | 04bafe1 | 2021-06-29 00:20:25 -0700 | [diff] [blame] | 1398 | "antennaModel": "A String", # If populated, the Antenna Model Pattern to use. Format is: RecordCreatorId:PatternId |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1399 | }, |
| 1400 | "displayName": "A String", # Device display name. |
| 1401 | "fccId": "A String", # The FCC identifier of the device. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1402 | "grantRangeAllowlists": [ # Only ranges within the allowlists are available for new grants. |
| 1403 | { # Frequency range from `low_frequency` to `high_frequency`. |
| 1404 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1405 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| 1406 | }, |
| 1407 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1408 | "grants": [ # Output only. Grants held by the device. |
| 1409 | { # 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. |
| 1410 | "channelType": "A String", # Type of channel used. |
| 1411 | "expireTime": "A String", # The expiration time of the grant. |
| 1412 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The transmission frequency range. |
| 1413 | "highFrequencyMhz": 3.14, # The highest frequency of the frequency range in MHz. |
| 1414 | "lowFrequencyMhz": 3.14, # The lowest frequency of the frequency range in MHz. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame] | 1415 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1416 | "grantId": "A String", # Grant Id. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1417 | "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). |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1418 | "moveList": [ # The DPA move lists on which this grant appears. |
| 1419 | { # An entry in a DPA's move list. |
| 1420 | "dpaId": "A String", # The ID of the DPA. |
| 1421 | "frequencyRange": { # Frequency range from `low_frequency` to `high_frequency`. # The frequency range that the move list affects. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 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 | }, |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 1425 | }, |
| 1426 | ], |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1427 | "state": "A String", # State of the grant. |
| 1428 | "suspensionReason": [ # If the grant is suspended, the reason(s) for suspension. |
| 1429 | "A String", |
| 1430 | ], |
| 1431 | }, |
| 1432 | ], |
| 1433 | "name": "A String", # Output only. The resource path name. |
| 1434 | "preloadedConfig": { # Information about the device configuration. # Configuration of the device, as specified via SAS Portal API. |
| 1435 | "airInterface": { # Information about the device's air interface. # Information about this device's air interface. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1436 | "radioTechnology": "A String", # Conditional. This field specifies the radio access technology that is used for the CBSD. |
| 1437 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1438 | }, |
| 1439 | "callSign": "A String", # The call sign of the device operator. |
| 1440 | "category": "A String", # FCC category of the device. |
| 1441 | "installationParams": { # Information about the device installation parameters. # Installation parameters for the device. |
| 1442 | "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. |
| 1443 | "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. |
| 1444 | "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. |
| 1445 | "antennaGain": 42, # Peak antenna gain in dBi. This parameter is an integer with a value between -127 and +128 (dBi) inclusive. |
| 1446 | "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. |
| 1447 | "cpeCbsdIndication": True or False, # If present, this parameter specifies whether the CBSD is a CPE-CBSD or not. |
| 1448 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1449 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1450 | "heightType": "A String", # Specifies how the height is measured. |
| 1451 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1452 | "indoorDeployment": True or False, # Whether the device antenna is indoor or not. `true`: indoor. `false`: outdoor. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1453 | "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. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1454 | "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. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1455 | "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. |
| 1456 | }, |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1457 | "isSigned": True or False, # Output only. Whether the configuration has been signed by a CPI. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1458 | "measurementCapabilities": [ # Measurement reporting capabilities of the device. |
| 1459 | "A String", |
| 1460 | ], |
| 1461 | "model": { # Information about the model of the device. # Information about this device model. |
| 1462 | "firmwareVersion": "A String", # The firmware version of the device. |
| 1463 | "hardwareVersion": "A String", # The hardware version of the device. |
| 1464 | "name": "A String", # The name of the device model. |
| 1465 | "softwareVersion": "A String", # The software version of the device. |
| 1466 | "vendor": "A String", # The name of the device vendor. |
| 1467 | }, |
| 1468 | "state": "A String", # State of the configuration. |
| yoshi-code-bot | b6dc1b9 | 2021-03-02 11:49:08 -0800 | [diff] [blame] | 1469 | "updateTime": "A String", # Output only. The last time the device configuration was edited. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 1470 | "userId": "A String", # The identifier of a device user. |
| 1471 | }, |
| 1472 | "serialNumber": "A String", # A serial number assigned to the device by the device manufacturer. |
| 1473 | "state": "A String", # Output only. Device state. |
| 1474 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1475 | </div> |
| 1476 | |
| 1477 | </body></html> |