| 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.ProximityBeacon
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- proximitybeacon.beaconinfo.getforobserved
- proximitybeacon.beacons.activate
- proximitybeacon.beacons.attachments.batchDelete
- proximitybeacon.beacons.attachments.create
- proximitybeacon.beacons.attachments.delete
- proximitybeacon.beacons.attachments.list
- proximitybeacon.beacons.deactivate
- proximitybeacon.beacons.decommission
- proximitybeacon.beacons.delete
- proximitybeacon.beacons.diagnostics.list
- proximitybeacon.beacons.get
- proximitybeacon.beacons.list
- proximitybeacon.beacons.register
- proximitybeacon.beacons.update
- proximitybeacon.getEidparams
- proximitybeacon.namespaces.list
- proximitybeacon.namespaces.update
- Types
- LatLng
- AttachmentInfo
- BeaconExpectedStability
- NamespaceServingVisibility
- BeaconProperties
- Empty
- DeleteAttachmentsResponse
- GetInfoForObservedBeaconsRequest
- Namespace
- EphemeralIdRegistration
- AdvertisedIdType
- ListNamespacesResponse
- Date
- Beacon
- Diagnostics
- ListBeaconAttachmentsResponse
- IndoorLevel
- EphemeralIdRegistrationParams
- Xgafv
- BeaconInfo
- Observation
- BeaconAttachment
- ListDiagnosticsResponse
- BeaconStatus
- AdvertisedId
- ListBeaconsResponse
- GetInfoForObservedBeaconsResponse
Description
Registers, manages, indexes, and searches beacons.
Synopsis
- proximityBeaconService :: ServiceConfig
- userlocationBeaconRegistryScope :: Proxy '["https://www.googleapis.com/auth/userlocation.beacon.registry"]
- type ProximityBeaconAPI = GetEidparamsResource :<|> (BeaconsAttachmentsListResource :<|> (BeaconsAttachmentsCreateResource :<|> (BeaconsAttachmentsBatchDeleteResource :<|> (BeaconsAttachmentsDeleteResource :<|> (BeaconsDiagnosticsListResource :<|> (BeaconsListResource :<|> (BeaconsDeactivateResource :<|> (BeaconsGetResource :<|> (BeaconsActivateResource :<|> (BeaconsRegisterResource :<|> (BeaconsDecommissionResource :<|> (BeaconsDeleteResource :<|> (BeaconsUpdateResource :<|> (NamespacesListResource :<|> (NamespacesUpdateResource :<|> BeaconInfoGetforObservedResource)))))))))))))))
- module Network.Google.Resource.ProximityBeacon.BeaconInfo.GetforObserved
- module Network.Google.Resource.ProximityBeacon.Beacons.Activate
- module Network.Google.Resource.ProximityBeacon.Beacons.Attachments.BatchDelete
- module Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Create
- module Network.Google.Resource.ProximityBeacon.Beacons.Attachments.Delete
- module Network.Google.Resource.ProximityBeacon.Beacons.Attachments.List
- module Network.Google.Resource.ProximityBeacon.Beacons.Deactivate
- module Network.Google.Resource.ProximityBeacon.Beacons.Decommission
- module Network.Google.Resource.ProximityBeacon.Beacons.Delete
- module Network.Google.Resource.ProximityBeacon.Beacons.Diagnostics.List
- module Network.Google.Resource.ProximityBeacon.Beacons.Get
- module Network.Google.Resource.ProximityBeacon.Beacons.List
- module Network.Google.Resource.ProximityBeacon.Beacons.Register
- module Network.Google.Resource.ProximityBeacon.Beacons.Update
- module Network.Google.Resource.ProximityBeacon.GetEidparams
- module Network.Google.Resource.ProximityBeacon.Namespaces.List
- module Network.Google.Resource.ProximityBeacon.Namespaces.Update
- data LatLng
- latLng :: LatLng
- llLatitude :: Lens' LatLng (Maybe Double)
- llLongitude :: Lens' LatLng (Maybe Double)
- data AttachmentInfo
- attachmentInfo :: AttachmentInfo
- aiMaxDistanceMeters :: Lens' AttachmentInfo (Maybe Double)
- aiData :: Lens' AttachmentInfo (Maybe ByteString)
- aiNamespacedType :: Lens' AttachmentInfo (Maybe Text)
- data BeaconExpectedStability
- data NamespaceServingVisibility
- data BeaconProperties
- beaconProperties :: HashMap Text Text -> BeaconProperties
- bpAddtional :: Lens' BeaconProperties (HashMap Text Text)
- data Empty
- empty :: Empty
- data DeleteAttachmentsResponse
- deleteAttachmentsResponse :: DeleteAttachmentsResponse
- darNumDeleted :: Lens' DeleteAttachmentsResponse (Maybe Int32)
- data GetInfoForObservedBeaconsRequest
- getInfoForObservedBeaconsRequest :: GetInfoForObservedBeaconsRequest
- gifobrObservations :: Lens' GetInfoForObservedBeaconsRequest [Observation]
- gifobrNamespacedTypes :: Lens' GetInfoForObservedBeaconsRequest [Text]
- data Namespace
- namespace :: Namespace
- nServingVisibility :: Lens' Namespace (Maybe NamespaceServingVisibility)
- nNamespaceName :: Lens' Namespace (Maybe Text)
- data EphemeralIdRegistration
- ephemeralIdRegistration :: EphemeralIdRegistration
- eirRotationPeriodExponent :: Lens' EphemeralIdRegistration (Maybe Word32)
- eirInitialClockValue :: Lens' EphemeralIdRegistration (Maybe Word64)
- eirBeaconIdentityKey :: Lens' EphemeralIdRegistration (Maybe ByteString)
- eirBeaconEcdhPublicKey :: Lens' EphemeralIdRegistration (Maybe ByteString)
- eirInitialEid :: Lens' EphemeralIdRegistration (Maybe ByteString)
- eirServiceEcdhPublicKey :: Lens' EphemeralIdRegistration (Maybe ByteString)
- data AdvertisedIdType
- data ListNamespacesResponse
- listNamespacesResponse :: ListNamespacesResponse
- lnrNamespaces :: Lens' ListNamespacesResponse [Namespace]
- data Date
- date :: Date
- dDay :: Lens' Date (Maybe Int32)
- dYear :: Lens' Date (Maybe Int32)
- dMonth :: Lens' Date (Maybe Int32)
- data Beacon
- beacon :: Beacon
- beaLatLng :: Lens' Beacon (Maybe LatLng)
- beaStatus :: Lens' Beacon (Maybe BeaconStatus)
- beaBeaconName :: Lens' Beacon (Maybe Text)
- beaEphemeralIdRegistration :: Lens' Beacon (Maybe EphemeralIdRegistration)
- beaIndoorLevel :: Lens' Beacon (Maybe IndoorLevel)
- beaExpectedStability :: Lens' Beacon (Maybe BeaconExpectedStability)
- beaProvisioningKey :: Lens' Beacon (Maybe ByteString)
- beaDescription :: Lens' Beacon (Maybe Text)
- beaPlaceId :: Lens' Beacon (Maybe Text)
- beaAdvertisedId :: Lens' Beacon (Maybe AdvertisedId)
- beaProperties :: Lens' Beacon (Maybe BeaconProperties)
- data Diagnostics
- diagnostics :: Diagnostics
- dAlerts :: Lens' Diagnostics [Text]
- dBeaconName :: Lens' Diagnostics (Maybe Text)
- dEstimatedLowBatteryDate :: Lens' Diagnostics (Maybe Date)
- data ListBeaconAttachmentsResponse
- listBeaconAttachmentsResponse :: ListBeaconAttachmentsResponse
- lbarAttachments :: Lens' ListBeaconAttachmentsResponse [BeaconAttachment]
- data IndoorLevel
- indoorLevel :: IndoorLevel
- ilName :: Lens' IndoorLevel (Maybe Text)
- data EphemeralIdRegistrationParams
- ephemeralIdRegistrationParams :: EphemeralIdRegistrationParams
- eirpMinRotationPeriodExponent :: Lens' EphemeralIdRegistrationParams (Maybe Word32)
- eirpMaxRotationPeriodExponent :: Lens' EphemeralIdRegistrationParams (Maybe Word32)
- eirpServiceEcdhPublicKey :: Lens' EphemeralIdRegistrationParams (Maybe ByteString)
- data Xgafv
- data BeaconInfo
- beaconInfo :: BeaconInfo
- biAttachments :: Lens' BeaconInfo [AttachmentInfo]
- biBeaconName :: Lens' BeaconInfo (Maybe Text)
- biAdvertisedId :: Lens' BeaconInfo (Maybe AdvertisedId)
- data Observation
- observation :: Observation
- oTelemetry :: Lens' Observation (Maybe ByteString)
- oTimestampMs :: Lens' Observation (Maybe UTCTime)
- oAdvertisedId :: Lens' Observation (Maybe AdvertisedId)
- data BeaconAttachment
- beaconAttachment :: BeaconAttachment
- baMaxDistanceMeters :: Lens' BeaconAttachment (Maybe Double)
- baCreationTimeMs :: Lens' BeaconAttachment (Maybe UTCTime)
- baData :: Lens' BeaconAttachment (Maybe ByteString)
- baAttachmentName :: Lens' BeaconAttachment (Maybe Text)
- baNamespacedType :: Lens' BeaconAttachment (Maybe Text)
- data ListDiagnosticsResponse
- listDiagnosticsResponse :: ListDiagnosticsResponse
- ldrNextPageToken :: Lens' ListDiagnosticsResponse (Maybe Text)
- ldrDiagnostics :: Lens' ListDiagnosticsResponse [Diagnostics]
- data BeaconStatus
- data AdvertisedId
- advertisedId :: AdvertisedId
- aiId :: Lens' AdvertisedId (Maybe ByteString)
- aiType :: Lens' AdvertisedId (Maybe AdvertisedIdType)
- data ListBeaconsResponse
- listBeaconsResponse :: ListBeaconsResponse
- lbrNextPageToken :: Lens' ListBeaconsResponse (Maybe Text)
- lbrBeacons :: Lens' ListBeaconsResponse [Beacon]
- lbrTotalCount :: Lens' ListBeaconsResponse (Maybe Int64)
- data GetInfoForObservedBeaconsResponse
- getInfoForObservedBeaconsResponse :: GetInfoForObservedBeaconsResponse
- gifobrBeacons :: Lens' GetInfoForObservedBeaconsResponse [BeaconInfo]
Service Configuration
proximityBeaconService :: ServiceConfig Source #
Default request referring to version v1beta1 of the Proximity Beacon API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
userlocationBeaconRegistryScope :: Proxy '["https://www.googleapis.com/auth/userlocation.beacon.registry"] Source #
View and modify your beacons
API Declaration
type ProximityBeaconAPI = GetEidparamsResource :<|> (BeaconsAttachmentsListResource :<|> (BeaconsAttachmentsCreateResource :<|> (BeaconsAttachmentsBatchDeleteResource :<|> (BeaconsAttachmentsDeleteResource :<|> (BeaconsDiagnosticsListResource :<|> (BeaconsListResource :<|> (BeaconsDeactivateResource :<|> (BeaconsGetResource :<|> (BeaconsActivateResource :<|> (BeaconsRegisterResource :<|> (BeaconsDecommissionResource :<|> (BeaconsDeleteResource :<|> (BeaconsUpdateResource :<|> (NamespacesListResource :<|> (NamespacesUpdateResource :<|> BeaconInfoGetforObservedResource))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Proximity Beacon API service.
Resources
proximitybeacon.beaconinfo.getforobserved
proximitybeacon.beacons.activate
proximitybeacon.beacons.attachments.batchDelete
proximitybeacon.beacons.attachments.create
proximitybeacon.beacons.attachments.delete
proximitybeacon.beacons.attachments.list
proximitybeacon.beacons.deactivate
proximitybeacon.beacons.decommission
proximitybeacon.beacons.delete
proximitybeacon.beacons.diagnostics.list
proximitybeacon.beacons.get
proximitybeacon.beacons.list
proximitybeacon.beacons.register
proximitybeacon.beacons.update
proximitybeacon.getEidparams
proximitybeacon.namespaces.list
proximitybeacon.namespaces.update
Types
LatLng
An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.
See: latLng smart constructor.
Instances
| Eq LatLng Source # | |
| Data LatLng Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LatLng -> c LatLng # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LatLng # toConstr :: LatLng -> Constr # dataTypeOf :: LatLng -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LatLng) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LatLng) # gmapT :: (forall b. Data b => b -> b) -> LatLng -> LatLng # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LatLng -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LatLng -> r # gmapQ :: (forall d. Data d => d -> u) -> LatLng -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LatLng -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LatLng -> m LatLng # | |
| Show LatLng Source # | |
| Generic LatLng Source # | |
| ToJSON LatLng Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product | |
| FromJSON LatLng Source # | |
| type Rep LatLng Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product type Rep LatLng = D1 (MetaData "LatLng" "Network.Google.ProximityBeacon.Types.Product" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "LatLng'" PrefixI True) (S1 (MetaSel (Just "_llLatitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))) :*: S1 (MetaSel (Just "_llLongitude") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) | |
Creates a value of LatLng with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llLatitude :: Lens' LatLng (Maybe Double) Source #
The latitude in degrees. It must be in the range [-90.0, +90.0].
llLongitude :: Lens' LatLng (Maybe Double) Source #
The longitude in degrees. It must be in the range [-180.0, +180.0].
AttachmentInfo
data AttachmentInfo Source #
A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.
See: attachmentInfo smart constructor.
Instances
attachmentInfo :: AttachmentInfo Source #
Creates a value of AttachmentInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiMaxDistanceMeters :: Lens' AttachmentInfo (Maybe Double) Source #
The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection.
aiData :: Lens' AttachmentInfo (Maybe ByteString) Source #
An opaque data container for client-provided data.
aiNamespacedType :: Lens' AttachmentInfo (Maybe Text) Source #
Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type, for example 'scrupulous-wombat-12345\/welcome-message'
BeaconExpectedStability
data BeaconExpectedStability Source #
Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
Constructors
| StabilityUnspecified |
|
| Stable |
|
| Portable |
|
| Mobile |
|
| Roving |
|
Instances
NamespaceServingVisibility
data NamespaceServingVisibility Source #
Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
Constructors
| VisibilityUnspecified |
|
| UnListed |
|
| Public |
|
Instances
BeaconProperties
data BeaconProperties Source #
Properties of the beacon device, for example battery type or firmware version. Optional.
See: beaconProperties smart constructor.
Instances
Arguments
| :: HashMap Text Text | |
| -> BeaconProperties |
Creates a value of BeaconProperties with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Empty
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 `{}`.
See: empty smart constructor.
Instances
| Eq Empty Source # | |
| Data Empty Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Empty -> c Empty # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Empty # dataTypeOf :: Empty -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Empty) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Empty) # gmapT :: (forall b. Data b => b -> b) -> Empty -> Empty # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Empty -> r # gmapQ :: (forall d. Data d => d -> u) -> Empty -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Empty -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Empty -> m Empty # | |
| Show Empty Source # | |
| Generic Empty Source # | |
| ToJSON Empty Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product | |
| FromJSON Empty Source # | |
| type Rep Empty Source # | |
DeleteAttachmentsResponse
data DeleteAttachmentsResponse Source #
Response for a request to delete attachments.
See: deleteAttachmentsResponse smart constructor.
Instances
deleteAttachmentsResponse :: DeleteAttachmentsResponse Source #
Creates a value of DeleteAttachmentsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
darNumDeleted :: Lens' DeleteAttachmentsResponse (Maybe Int32) Source #
The number of attachments that were deleted.
GetInfoForObservedBeaconsRequest
data GetInfoForObservedBeaconsRequest Source #
Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".
See: getInfoForObservedBeaconsRequest smart constructor.
Instances
getInfoForObservedBeaconsRequest :: GetInfoForObservedBeaconsRequest Source #
Creates a value of GetInfoForObservedBeaconsRequest with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gifobrObservations :: Lens' GetInfoForObservedBeaconsRequest [Observation] Source #
The beacons that the client has encountered. At least one must be given.
gifobrNamespacedTypes :: Lens' GetInfoForObservedBeaconsRequest [Text] Source #
Specifies what kind of attachments to include in the response. When given, the response will include only attachments of the given types. When empty, no attachments will be returned. Must be in the format namespace/type. Accepts `*` to specify all types in all namespaces owned by the client. Optional.
Namespace
An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.
See: namespace smart constructor.
Instances
| Eq Namespace Source # | |
| Data Namespace Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Namespace -> c Namespace # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Namespace # toConstr :: Namespace -> Constr # dataTypeOf :: Namespace -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Namespace) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Namespace) # gmapT :: (forall b. Data b => b -> b) -> Namespace -> Namespace # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Namespace -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Namespace -> r # gmapQ :: (forall d. Data d => d -> u) -> Namespace -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Namespace -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Namespace -> m Namespace # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Namespace -> m Namespace # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Namespace -> m Namespace # | |
| Show Namespace Source # | |
| Generic Namespace Source # | |
| ToJSON Namespace Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product | |
| FromJSON Namespace Source # | |
| type Rep Namespace Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product type Rep Namespace = D1 (MetaData "Namespace" "Network.Google.ProximityBeacon.Types.Product" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "Namespace'" PrefixI True) (S1 (MetaSel (Just "_nServingVisibility") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NamespaceServingVisibility)) :*: S1 (MetaSel (Just "_nNamespaceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) | |
namespace :: Namespace Source #
Creates a value of Namespace with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nServingVisibility :: Lens' Namespace (Maybe NamespaceServingVisibility) Source #
Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
nNamespaceName :: Lens' Namespace (Maybe Text) Source #
Resource name of this namespace. Namespaces names have the format: 'namespaces\/namespace'.
EphemeralIdRegistration
data EphemeralIdRegistration Source #
Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported: 1. Perform an ECDH key exchange via this API, including a previous call to `GET /v1beta1/eidparams`. In this case the fields `beacon_ecdh_public_key` and `service_ecdh_public_key` should be populated and `beacon_identity_key` should not be populated. This method ensures that only the two parties in the ECDH key exchange can compute the identity key, which becomes a secret between them. 2. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile device or any other secure method), and then submit the resulting identity key to the service. In this case `beacon_identity_key` field should be populated, and neither of `beacon_ecdh_public_key` nor `service_ecdh_public_key` fields should be. The security of this method depends on how securely the parties involved (in particular the bluetooth client) handle the identity key, and obviously on how securely the identity key was generated. See the Eddystone specification at GitHub.
See: ephemeralIdRegistration smart constructor.
Instances
ephemeralIdRegistration :: EphemeralIdRegistration Source #
Creates a value of EphemeralIdRegistration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eirRotationPeriodExponent :: Lens' EphemeralIdRegistration (Maybe Word32) Source #
Indicates the nominal period between each rotation of the beacon's ephemeral ID. "Nominal" because the beacon should randomize the actual interval. See the spec at github for details. This value corresponds to a power-of-two scaler on the beacon's clock: when the scaler value is K, the beacon will begin broadcasting a new ephemeral ID on average every 2^K seconds.
eirInitialClockValue :: Lens' EphemeralIdRegistration (Maybe Word64) Source #
The initial clock value of the beacon. The beacon's clock must have begun counting at this value immediately prior to transmitting this value to the resolving service. Significant delay in transmitting this value to the service risks registration or resolution failures. If a value is not provided, the default is zero.
eirBeaconIdentityKey :: Lens' EphemeralIdRegistration (Maybe ByteString) Source #
The private key of the beacon. If this field is populated, `beacon_ecdh_public_key` and `service_ecdh_public_key` must not be populated.
eirBeaconEcdhPublicKey :: Lens' EphemeralIdRegistration (Maybe ByteString) Source #
The beacon's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `service_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
eirInitialEid :: Lens' EphemeralIdRegistration (Maybe ByteString) Source #
An initial ephemeral ID calculated using the clock value submitted as `initial_clock_value`, and the secret key generated by the Diffie-Hellman key exchange using `service_ecdh_public_key` and `service_ecdh_public_key`. This initial EID value will be used by the service to confirm that the key exchange process was successful.
eirServiceEcdhPublicKey :: Lens' EphemeralIdRegistration (Maybe ByteString) Source #
The service's public key used for the Elliptic curve Diffie-Hellman key exchange. When this field is populated, `beacon_ecdh_public_key` must also be populated, and `beacon_identity_key` must not be.
AdvertisedIdType
data AdvertisedIdType Source #
Specifies the identifier type. Required.
Constructors
| TypeUnspecified |
|
| Eddystone |
|
| Ibeacon |
|
| Altbeacon |
|
| EddystoneEid |
|
Instances
ListNamespacesResponse
data ListNamespacesResponse Source #
Response to ListNamespacesRequest that contains all the project's namespaces.
See: listNamespacesResponse smart constructor.
Instances
listNamespacesResponse :: ListNamespacesResponse Source #
Creates a value of ListNamespacesResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lnrNamespaces :: Lens' ListNamespacesResponse [Namespace] Source #
The attachments that corresponded to the request params.
Date
Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
See: date smart constructor.
Instances
| Eq Date Source # | |
| Data Date Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # | |
| Show Date Source # | |
| Generic Date Source # | |
| ToJSON Date Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product | |
| FromJSON Date Source # | |
| type Rep Date Source # | |
Defined in Network.Google.ProximityBeacon.Types.Product type Rep Date = D1 (MetaData "Date" "Network.Google.ProximityBeacon.Types.Product" "gogol-proximitybeacon-0.4.0-81RQBGEh3ZRFwA4LNDaUi1" False) (C1 (MetaCons "Date'" PrefixI True) (S1 (MetaSel (Just "_dDay") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_dYear") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_dMonth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) | |
dDay :: Lens' Date (Maybe Int32) Source #
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
dYear :: Lens' Date (Maybe Int32) Source #
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
dMonth :: Lens' Date (Maybe Int32) Source #
Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
Beacon
Details of a beacon device.
See: beacon smart constructor.
Instances
Creates a value of Beacon with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
beaLatLng :: Lens' Beacon (Maybe LatLng) Source #
The location of the beacon, expressed as a latitude and longitude pair. This location is given when the beacon is registered or updated. It does not necessarily indicate the actual current location of the beacon. Optional.
beaBeaconName :: Lens' Beacon (Maybe 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.
beaEphemeralIdRegistration :: Lens' Beacon (Maybe EphemeralIdRegistration) Source #
Write-only registration parameters for beacons using Eddystone-EID (remotely resolved ephemeral ID) format. This information will not be populated in API responses. When submitting this data, the `advertised_id` field must contain an ID of type Eddystone-UID. Any other ID type will result in an error.
beaIndoorLevel :: Lens' Beacon (Maybe IndoorLevel) Source #
The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
beaExpectedStability :: Lens' Beacon (Maybe BeaconExpectedStability) Source #
Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
beaProvisioningKey :: Lens' Beacon (Maybe ByteString) Source #
Some beacons may require a user to provide an authorization key before changing any of its configuration (e.g. broadcast frames, transmit power). This field provides a place to store and control access to that key. This field is populated in responses to `GET /v1beta1/beacons/3!beaconId` from users with write access to the given beacon. That is to say: If the user is authorized to write the beacon's confidential data in the service, the service considers them authorized to configure the beacon. Note that this key grants nothing on the service, only on the beacon itself.
beaDescription :: Lens' Beacon (Maybe Text) Source #
Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
beaPlaceId :: Lens' Beacon (Maybe Text) Source #
The Google Places API Place ID of the place where the beacon is deployed. This is given when the beacon is registered or updated, not automatically detected in any way. Optional.
beaAdvertisedId :: Lens' Beacon (Maybe AdvertisedId) Source #
The identifier of a beacon as advertised by it. This field must be populated when registering. It may be empty when updating a beacon record because it is ignored in updates. When registering a beacon that broadcasts Eddystone-EID, this field should contain a "stable" Eddystone-UID that identifies the beacon and links it to its attachments. The stable Eddystone-UID is only used for administering the beacon.
beaProperties :: Lens' Beacon (Maybe BeaconProperties) Source #
Properties of the beacon device, for example battery type or firmware version. Optional.
Diagnostics
data Diagnostics Source #
Diagnostics for a single beacon.
See: diagnostics smart constructor.
Instances
diagnostics :: Diagnostics Source #
Creates a value of Diagnostics with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dBeaconName :: Lens' Diagnostics (Maybe Text) Source #
Resource name of the beacon. For Eddystone-EID beacons, this may be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
dEstimatedLowBatteryDate :: Lens' Diagnostics (Maybe Date) Source #
The date when the battery is expected to be low. If the value is missing then there is no estimate for when the battery will be low. This value is only an estimate, not an exact date.
ListBeaconAttachmentsResponse
data ListBeaconAttachmentsResponse Source #
Response to `ListBeaconAttachments` that contains the requested attachments.
See: listBeaconAttachmentsResponse smart constructor.
Instances
listBeaconAttachmentsResponse :: ListBeaconAttachmentsResponse Source #
Creates a value of ListBeaconAttachmentsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lbarAttachments :: Lens' ListBeaconAttachmentsResponse [BeaconAttachment] Source #
The attachments that corresponded to the request params.
IndoorLevel
data IndoorLevel Source #
Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on.
See: indoorLevel smart constructor.
Instances
indoorLevel :: IndoorLevel Source #
Creates a value of IndoorLevel with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
EphemeralIdRegistrationParams
data EphemeralIdRegistrationParams Source #
Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See the Eddystone specification at GitHub.
See: ephemeralIdRegistrationParams smart constructor.
Instances
ephemeralIdRegistrationParams :: EphemeralIdRegistrationParams Source #
Creates a value of EphemeralIdRegistrationParams with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eirpMinRotationPeriodExponent :: Lens' EphemeralIdRegistrationParams (Maybe Word32) Source #
Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
eirpMaxRotationPeriodExponent :: Lens' EphemeralIdRegistrationParams (Maybe Word32) Source #
Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
eirpServiceEcdhPublicKey :: Lens' EphemeralIdRegistrationParams (Maybe ByteString) Source #
The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange.
Xgafv
V1 error format.
Instances
BeaconInfo
data BeaconInfo Source #
A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.
See: beaconInfo smart constructor.
Instances
beaconInfo :: BeaconInfo Source #
Creates a value of BeaconInfo with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
biAttachments :: Lens' BeaconInfo [AttachmentInfo] Source #
Attachments matching the type(s) requested. May be empty if no attachment types were requested.
biBeaconName :: Lens' BeaconInfo (Maybe Text) Source #
The name under which the beacon is registered.
biAdvertisedId :: Lens' BeaconInfo (Maybe AdvertisedId) Source #
The ID advertised by the beacon.
Observation
data Observation Source #
Represents one beacon observed once.
See: observation smart constructor.
Instances
observation :: Observation Source #
Creates a value of Observation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oTelemetry :: Lens' Observation (Maybe ByteString) Source #
The array of telemetry bytes received from the beacon. The server is responsible for parsing it. This field may frequently be empty, as with a beacon that transmits telemetry only occasionally.
oTimestampMs :: Lens' Observation (Maybe UTCTime) Source #
Time when the beacon was observed.
oAdvertisedId :: Lens' Observation (Maybe AdvertisedId) Source #
The ID advertised by the beacon the client has encountered. If the submitted `advertised_id` type is Eddystone-EID, then the client must be authorized to resolve the given beacon. Otherwise no data will be returned for that beacon. Required.
BeaconAttachment
data BeaconAttachment Source #
Project-specific data associated with a beacon.
See: beaconAttachment smart constructor.
Instances
beaconAttachment :: BeaconAttachment Source #
Creates a value of BeaconAttachment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
baMaxDistanceMeters :: Lens' BeaconAttachment (Maybe Double) Source #
The distance away from the beacon at which this attachment should be delivered to a mobile app. Setting this to a value greater than zero indicates that the app should behave as if the beacon is "seen" when the mobile device is less than this distance away from the beacon. Different attachments on the same beacon can have different max distances. Note that even though this value is expressed with fractional meter precision, real-world behavior is likley to be much less precise than one meter, due to the nature of current Bluetooth radio technology. Optional. When not set or zero, the attachment should be delivered at the beacon's outer limit of detection. Negative values are invalid and return an error.
baCreationTimeMs :: Lens' BeaconAttachment (Maybe UTCTime) Source #
The UTC time when this attachment was created, in milliseconds since the UNIX epoch.
baData :: Lens' BeaconAttachment (Maybe ByteString) Source #
An opaque data container for client-provided data. Must be base64 encoded in HTTP requests, and will be so encoded (with padding) in responses. Required.
baAttachmentName :: Lens' BeaconAttachment (Maybe Text) Source #
Resource name of this attachment. Attachment names have the format: 'beacons\/beacon_id\/attachments\/attachment_id'. Leave this empty on creation.
baNamespacedType :: Lens' BeaconAttachment (Maybe Text) Source #
Specifies what kind of attachment this is. Tells a client how to interpret the `data` field. Format is namespace/type. Namespace provides type separation between clients. Type describes the type of `data`, for use by the client when parsing the `data` field. Required.
ListDiagnosticsResponse
data ListDiagnosticsResponse Source #
Response that contains the requested diagnostics.
See: listDiagnosticsResponse smart constructor.
Instances
listDiagnosticsResponse :: ListDiagnosticsResponse Source #
Creates a value of ListDiagnosticsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldrNextPageToken :: Lens' ListDiagnosticsResponse (Maybe Text) Source #
Token that can be used for pagination. Returned only if the request matches more beacons than can be returned in this response.
ldrDiagnostics :: Lens' ListDiagnosticsResponse [Diagnostics] Source #
The diagnostics matching the given request.
BeaconStatus
data BeaconStatus Source #
Current status of the beacon. Required.
Constructors
| StatusUnspecified |
|
| Active |
|
| Decommissioned |
|
| Inactive |
|
Instances
AdvertisedId
data AdvertisedId Source #
Defines a unique identifier of a beacon as broadcast by the device.
See: advertisedId smart constructor.
Instances
advertisedId :: AdvertisedId Source #
Creates a value of AdvertisedId with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiId :: Lens' AdvertisedId (Maybe ByteString) Source #
The actual beacon identifier, as broadcast by the beacon hardware. Must be base64 encoded in HTTP requests, and will be so encoded (with padding) in responses. The base64 encoding should be of the binary byte-stream and not any textual (such as hex) representation thereof. Required.
aiType :: Lens' AdvertisedId (Maybe AdvertisedIdType) Source #
Specifies the identifier type. Required.
ListBeaconsResponse
data ListBeaconsResponse Source #
Response that contains list beacon results and pagination help.
See: listBeaconsResponse smart constructor.
Instances
listBeaconsResponse :: ListBeaconsResponse Source #
Creates a value of ListBeaconsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lbrNextPageToken :: Lens' ListBeaconsResponse (Maybe Text) Source #
An opaque pagination token that the client may provide in their next request to retrieve the next page of results.
lbrBeacons :: Lens' ListBeaconsResponse [Beacon] Source #
The beacons that matched the search criteria.
lbrTotalCount :: Lens' ListBeaconsResponse (Maybe Int64) Source #
Estimate of the total number of beacons matched by the query. Higher values may be less accurate.
GetInfoForObservedBeaconsResponse
data GetInfoForObservedBeaconsResponse Source #
Information about the requested beacons, optionally including attachment data.
See: getInfoForObservedBeaconsResponse smart constructor.
Instances
getInfoForObservedBeaconsResponse :: GetInfoForObservedBeaconsResponse Source #
Creates a value of GetInfoForObservedBeaconsResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gifobrBeacons :: Lens' GetInfoForObservedBeaconsResponse [BeaconInfo] Source #
Public information about beacons. May be empty if the request matched no beacons.