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.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Returns detailed information about the specified beacon. Authenticate using an OAuth access token from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

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

Synopsis

type BeaconsGetResource = "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 :> Get '[JSON] Beacon))))))))
beaconsGet :: Text -> BeaconsGet
data BeaconsGet
bgXgafv :: Lens' BeaconsGet (Maybe Xgafv)
bgUploadProtocol :: Lens' BeaconsGet (Maybe Text)
bgAccessToken :: Lens' BeaconsGet (Maybe Text)
bgBeaconName :: Lens' BeaconsGet Text
bgUploadType :: Lens' BeaconsGet (Maybe Text)
bgProjectId :: Lens' BeaconsGet (Maybe Text)
bgCallback :: Lens' BeaconsGet (Maybe Text)

REST Resource

type BeaconsGetResource = "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 :> Get '[JSON] Beacon)))))))) Source #

A resource alias for proximitybeacon.beacons.get method which the BeaconsGet request conforms to.

Creating a Request

beaconsGet Source #

Arguments

:: Text	`bgBeaconName`
-> BeaconsGet

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

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

data BeaconsGet Source #

Returns detailed information about the specified beacon. Authenticate using an OAuth access token from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project. Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

See: beaconsGet smart constructor.

Instances

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

Request Lenses

bgXgafv :: Lens' BeaconsGet (Maybe Xgafv) Source #

V1 error format.

bgUploadProtocol :: Lens' BeaconsGet (Maybe Text) Source #

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

bgAccessToken :: Lens' BeaconsGet (Maybe Text) Source #

OAuth access token.

bgBeaconName :: Lens' BeaconsGet 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-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5` for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

bgUploadType :: Lens' BeaconsGet (Maybe Text) Source #

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

bgProjectId :: Lens' BeaconsGet (Maybe Text) Source #

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

bgCallback :: Lens' BeaconsGet (Maybe Text) Source #

JSONP