Copyright	(c) 2015-2016 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

Contents

REST Resource
Creating a Request
Request Lenses

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 activation, deactivation, and decommissioning. Authenticate using an OAuth access token from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

See: Proximity Beacon API Reference for proximitybeacon.beacons.update.

Synopsis

type BeaconsUpdateResource = "v1beta1" :> (Capture "beaconName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Beacon :> Put '[JSON] Beacon)))))))))
beaconsUpdate :: Text -> Beacon -> BeaconsUpdate
data BeaconsUpdate
buXgafv :: Lens' BeaconsUpdate (Maybe Xgafv)
buUploadProtocol :: Lens' BeaconsUpdate (Maybe Text)
buAccessToken :: Lens' BeaconsUpdate (Maybe Text)
buBeaconName :: Lens' BeaconsUpdate Text
buUploadType :: Lens' BeaconsUpdate (Maybe Text)
buPayload :: Lens' BeaconsUpdate Beacon
buProjectId :: Lens' BeaconsUpdate (Maybe Text)
buCallback :: Lens' BeaconsUpdate (Maybe Text)

REST Resource

type BeaconsUpdateResource = "v1beta1" :> (Capture "beaconName" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "projectId" 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

beaconsUpdate Source #

Arguments

:: Text	`buBeaconName`
-> Beacon	`buPayload`
-> 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 activation, deactivation, and decommissioning. Authenticate using an OAuth access token from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

See: beaconsUpdate smart constructor.

Instances

Eq BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update Methods (==) :: BeaconsUpdate -> BeaconsUpdate -> Bool # (/=) :: BeaconsUpdate -> BeaconsUpdate -> Bool #
Data BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BeaconsUpdate -> c BeaconsUpdate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BeaconsUpdate # toConstr :: BeaconsUpdate -> Constr # dataTypeOf :: BeaconsUpdate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BeaconsUpdate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BeaconsUpdate) # gmapT :: (forall b. Data b => b -> b) -> BeaconsUpdate -> BeaconsUpdate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BeaconsUpdate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BeaconsUpdate -> r # gmapQ :: (forall d. Data d => d -> u) -> BeaconsUpdate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> BeaconsUpdate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> BeaconsUpdate -> m BeaconsUpdate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BeaconsUpdate -> m BeaconsUpdate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BeaconsUpdate -> m BeaconsUpdate #
Show BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update Methods showsPrec :: Int -> BeaconsUpdate -> ShowS # show :: BeaconsUpdate -> String # showList :: [BeaconsUpdate] -> ShowS #
Generic BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update Associated Types type Rep BeaconsUpdate :: Type -> Type # Methods from :: BeaconsUpdate -> Rep BeaconsUpdate x # to :: Rep BeaconsUpdate x -> BeaconsUpdate #
GoogleRequest BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update Associated Types type Rs BeaconsUpdate :: Type # type Scopes BeaconsUpdate :: [Symbol] # Methods requestClient :: BeaconsUpdate -> GClient (Rs BeaconsUpdate) #
type Rep BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update type Rep BeaconsUpdate = D1 (MetaData "BeaconsUpdate" "Network.Google.Resource.ProximityBeacon.Beacons.Update" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "BeaconsUpdate'" PrefixI True) (((S1 (MetaSel (Just "_buXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_buUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_buAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_buBeaconName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) :: ((S1 (MetaSel (Just "_buUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_buPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Beacon)) :: (S1 (MetaSel (Just "_buProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_buCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update type Scopes BeaconsUpdate = "https://www.googleapis.com/auth/userlocation.beacon.registry" ': ([] :: [Symbol])
type Rs BeaconsUpdate Source #
Instance details Defined in Network.Google.Resource.ProximityBeacon.Beacons.Update type Rs BeaconsUpdate = Beacon

Request Lenses

buXgafv :: Lens' BeaconsUpdate (Maybe Xgafv) Source #

V1 error format.

buUploadProtocol :: Lens' BeaconsUpdate (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

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.

buProjectId :: Lens' BeaconsUpdate (Maybe Text) Source #

The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon. Optional.

buCallback :: Lens' BeaconsUpdate (Maybe Text) Source #

JSONP