gogol-proximitybeacon-0.4.0: Google Proximity Beacon SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Contents

Description

Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. 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.decommission.

Synopsis

REST Resource

type BeaconsDecommissionResource = "v1beta1" :> (CaptureMode "beaconName" "decommission" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "projectId" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Post '[JSON] Empty)))))))) Source #

A resource alias for proximitybeacon.beacons.decommission method which the BeaconsDecommission request conforms to.

Creating a Request

beaconsDecommission Source #

Creates a value of BeaconsDecommission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data BeaconsDecommission Source #

Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again. 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: beaconsDecommission smart constructor.

Instances
Eq BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Data BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BeaconsDecommission -> c BeaconsDecommission #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BeaconsDecommission #

toConstr :: BeaconsDecommission -> Constr #

dataTypeOf :: BeaconsDecommission -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c BeaconsDecommission) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BeaconsDecommission) #

gmapT :: (forall b. Data b => b -> b) -> BeaconsDecommission -> BeaconsDecommission #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BeaconsDecommission -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BeaconsDecommission -> r #

gmapQ :: (forall d. Data d => d -> u) -> BeaconsDecommission -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BeaconsDecommission -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BeaconsDecommission -> m BeaconsDecommission #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BeaconsDecommission -> m BeaconsDecommission #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BeaconsDecommission -> m BeaconsDecommission #

Show BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Generic BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Associated Types

type Rep BeaconsDecommission :: Type -> Type #

GoogleRequest BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Associated Types

type Rs BeaconsDecommission :: Type #

type Scopes BeaconsDecommission :: [Symbol] #

type Rep BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

type Rep BeaconsDecommission = D1 (MetaData "BeaconsDecommission" "Network.Google.Resource.ProximityBeacon.Beacons.Decommission" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "BeaconsDecommission'" PrefixI True) ((S1 (MetaSel (Just "_bddXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_bddUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bddAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_bddBeaconName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_bddUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_bddProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_bddCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

type Scopes BeaconsDecommission = "https://www.googleapis.com/auth/userlocation.beacon.registry" ': ([] :: [Symbol])
type Rs BeaconsDecommission Source # 
Instance details

Defined in Network.Google.Resource.ProximityBeacon.Beacons.Decommission

Request Lenses

bddUploadProtocol :: Lens' BeaconsDecommission (Maybe Text) Source #

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

bddBeaconName :: Lens' BeaconsDecommission Text Source #

Beacon that should be decommissioned. 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-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's "stable" UID. Required.

bddUploadType :: Lens' BeaconsDecommission (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

bddProjectId :: Lens' BeaconsDecommission (Maybe Text) Source #

The project id of the beacon to decommission. 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.