| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.ProximityBeacon.Beacons.Update
Description
Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for (de)activation and decommissioning.
See: Google Proximity Beacon API Reference for proximitybeacon.beacons.update.
- type BeaconsUpdateResource = "v1beta1" :> (Capture "beaconName" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` Beacon :> Put `[JSON]` Beacon))))))))))
- beaconsUpdate :: Text -> Beacon -> BeaconsUpdate
- data BeaconsUpdate
- buXgafv :: Lens' BeaconsUpdate (Maybe Text)
- buUploadProtocol :: Lens' BeaconsUpdate (Maybe Text)
- buPp :: Lens' BeaconsUpdate Bool
- buAccessToken :: Lens' BeaconsUpdate (Maybe Text)
- buBeaconName :: Lens' BeaconsUpdate Text
- buUploadType :: Lens' BeaconsUpdate (Maybe Text)
- buPayload :: Lens' BeaconsUpdate Beacon
- buBearerToken :: Lens' BeaconsUpdate (Maybe Text)
- buCallback :: Lens' BeaconsUpdate (Maybe Text)
REST Resource
type BeaconsUpdateResource = "v1beta1" :> (Capture "beaconName" Text :> (QueryParam "$.xgafv" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "pp" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "bearer_token" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody `[JSON]` Beacon :> Put `[JSON]` Beacon)))))))))) Source
A resource alias for proximitybeacon.beacons.update method which the
BeaconsUpdate request conforms to.
Creating a Request
Arguments
| :: Text | |
| -> Beacon | |
| -> BeaconsUpdate |
Creates a value of BeaconsUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data BeaconsUpdate Source
Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data. Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for (de)activation and decommissioning.
See: beaconsUpdate smart constructor.
Request Lenses
buUploadProtocol :: Lens' BeaconsUpdate (Maybe Text) Source
Upload protocol for media (e.g. "raw", "multipart").
buPp :: Lens' BeaconsUpdate Bool Source
Pretty-print response.
buAccessToken :: Lens' BeaconsUpdate (Maybe Text) Source
OAuth access token.
buBeaconName :: Lens' BeaconsUpdate Text Source
Resource name of this beacon. A beacon name has the format "beacons/N!beaconId" where the beaconId is the base16 ID broadcast by the beacon and N is a code for the beacon's type. Possible values are `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon. This field must be left empty when registering. After reading a beacon, clients can use the name for future operations.
buUploadType :: Lens' BeaconsUpdate (Maybe Text) Source
Legacy upload protocol for media (e.g. "media", "multipart").
buPayload :: Lens' BeaconsUpdate Beacon Source
Multipart request metadata.
buBearerToken :: Lens' BeaconsUpdate (Maybe Text) Source
OAuth bearer token.
buCallback :: Lens' BeaconsUpdate (Maybe Text) Source
JSONP