| 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.Types
Contents
- Service Configuration
- OAuth Scopes
- LatLng
- AttachmentInfo
- BeaconProperties
- Empty
- DeleteAttachmentsResponse
- GetInfoForObservedBeaconsRequest
- Namespace
- EphemeralIdRegistration
- ListNamespacesResponse
- Date
- Beacon
- Diagnostics
- ListBeaconAttachmentsResponse
- IndoorLevel
- EphemeralIdRegistrationParams
- BeaconInfo
- Observation
- BeaconAttachment
- ListDiagnosticsResponse
- AdvertisedId
- ListBeaconsResponse
- GetInfoForObservedBeaconsResponse
Description
- proximityBeaconService :: ServiceConfig
- userlocationBeaconRegistryScope :: Proxy '["https://www.googleapis.com/auth/userlocation.beacon.registry"]
- data LatLng
- latLng :: LatLng
- llLatitude :: Lens' LatLng (Maybe Double)
- llLongitude :: Lens' LatLng (Maybe Double)
- data AttachmentInfo
- attachmentInfo :: AttachmentInfo
- aiData :: Lens' AttachmentInfo (Maybe ByteString)
- aiNamespacedType :: Lens' AttachmentInfo (Maybe Text)
- 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 Text)
- 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 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
- bLatLng :: Lens' Beacon (Maybe LatLng)
- bStatus :: Lens' Beacon (Maybe Text)
- bBeaconName :: Lens' Beacon (Maybe Text)
- bEphemeralIdRegistration :: Lens' Beacon (Maybe EphemeralIdRegistration)
- bIndoorLevel :: Lens' Beacon (Maybe IndoorLevel)
- bExpectedStability :: Lens' Beacon (Maybe Text)
- bProvisioningKey :: Lens' Beacon (Maybe ByteString)
- bDescription :: Lens' Beacon (Maybe Text)
- bPlaceId :: Lens' Beacon (Maybe Text)
- bAdvertisedId :: Lens' Beacon (Maybe AdvertisedId)
- bProperties :: 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 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 Text)
- oAdvertisedId :: Lens' Observation (Maybe AdvertisedId)
- data BeaconAttachment
- beaconAttachment :: BeaconAttachment
- 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 AdvertisedId
- advertisedId :: AdvertisedId
- aiId :: Lens' AdvertisedId (Maybe ByteString)
- aiType :: Lens' AdvertisedId (Maybe Text)
- 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 #
Default request referring to version v1beta1 of the Google 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"] #
View and modify your beacons
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. Example of normalization code in Python: def NormalizeLongitude(longitude): """Wraps decimal degrees longitude to [-180.0, 180.0].""" q, r = divmod(longitude, 360.0) if r > 180.0 or (r == 180.0 and q <= -1.0): return r - 360.0 return r def NormalizeLatLng(latitude, longitude): """Wraps decimal degrees latitude and longitude to [-90.0, 90.0] and [-180.0, 180.0], respectively.""" r = latitude % 360.0 if r = 270.0: return r - 360, NormalizeLongitude(longitude) else: return 180 - r, NormalizeLongitude(longitude + 180.0) assert 180.0 == NormalizeLongitude(180.0) assert -180.0 == NormalizeLongitude(-180.0) assert -179.0 == NormalizeLongitude(181.0) assert (0.0, 0.0) == NormalizeLatLng(360.0, 0.0) assert (0.0, 0.0) == NormalizeLatLng(-360.0, 0.0) assert (85.0, 180.0) == NormalizeLatLng(95.0, 0.0) assert (-85.0, -170.0) == NormalizeLatLng(-95.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(90.0, 10.0) assert (-90.0, -10.0) == NormalizeLatLng(-90.0, -10.0) assert (0.0, -170.0) == NormalizeLatLng(-180.0, 10.0) assert (0.0, -170.0) == NormalizeLatLng(180.0, 10.0) assert (-90.0, 10.0) == NormalizeLatLng(270.0, 10.0) assert (90.0, 10.0) == NormalizeLatLng(-270.0, 10.0)
See: latLng smart constructor.
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) #
The latitude in degrees. It must be in the range [-90.0, +90.0].
llLongitude :: Lens' LatLng (Maybe Double) #
The longitude in degrees. It must be in the range [-180.0, +180.0].
AttachmentInfo
data AttachmentInfo #
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 #
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:
aiData :: Lens' AttachmentInfo (Maybe ByteString) #
An opaque data container for client-provided data.
aiNamespacedType :: Lens' AttachmentInfo (Maybe Text) #
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
BeaconProperties
data BeaconProperties #
Properties of the beacon device, for example battery type or firmware version. Optional.
See: beaconProperties smart constructor.
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.
DeleteAttachmentsResponse
data DeleteAttachmentsResponse #
Response for a request to delete attachments.
See: deleteAttachmentsResponse smart constructor.
deleteAttachmentsResponse :: DeleteAttachmentsResponse #
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) #
The number of attachments that were deleted.
GetInfoForObservedBeaconsRequest
data GetInfoForObservedBeaconsRequest #
Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".
See: getInfoForObservedBeaconsRequest smart constructor.
Instances
getInfoForObservedBeaconsRequest :: GetInfoForObservedBeaconsRequest #
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] #
The beacons that the client has encountered. At least one must be given.
gifobrNamespacedTypes :: Lens' GetInfoForObservedBeaconsRequest [Text] #
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. 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.
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 Text) #
Specifies what clients may receive attachments under this namespace via `beaconinfo.getforobserved`.
nNamespaceName :: Lens' Namespace (Maybe Text) #
Resource name of this namespace. Namespaces names have the format: namespaces/namespace.
EphemeralIdRegistration
data EphemeralIdRegistration #
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.
ephemeralIdRegistration :: EphemeralIdRegistration #
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) #
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) #
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) #
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) #
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) #
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) #
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.
ListNamespacesResponse
data ListNamespacesResponse #
Response to ListNamespacesRequest that contains all the project's namespaces.
See: listNamespacesResponse smart constructor.
listNamespacesResponse :: ListNamespacesResponse #
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] #
The attachments that corresponded to the request params.
Date
Represents a whole calendar date, e.g. date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a year and month where the day is not significant, e.g. credit card expiration date. The year may be 0 to represent a month and day independent of year, e.g. anniversary date. Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
See: date smart constructor.
dDay :: Lens' Date (Maybe Int32) #
Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year/month where the day is not significant.
dYear :: Lens' Date (Maybe Int32) #
Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
Beacon
Details of a beacon device.
See: beacon smart constructor.
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:
bLatLng :: Lens' Beacon (Maybe LatLng) #
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.
bBeaconName :: Lens' Beacon (Maybe Text) #
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.
bEphemeralIdRegistration :: Lens' Beacon (Maybe EphemeralIdRegistration) #
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.
bIndoorLevel :: Lens' Beacon (Maybe IndoorLevel) #
The indoor level information for this beacon, if known. As returned by the Google Maps API. Optional.
bExpectedStability :: Lens' Beacon (Maybe Text) #
Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional.
bProvisioningKey :: Lens' Beacon (Maybe ByteString) #
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.
bDescription :: Lens' Beacon (Maybe Text) #
Free text used to identify and describe the beacon. Maximum length 140 characters. Optional.
bPlaceId :: Lens' Beacon (Maybe Text) #
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.
bAdvertisedId :: Lens' Beacon (Maybe AdvertisedId) #
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.
bProperties :: Lens' Beacon (Maybe BeaconProperties) #
Properties of the beacon device, for example battery type or firmware version. Optional.
Diagnostics
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:
dAlerts :: Lens' Diagnostics [Text] #
An unordered list of Alerts that the beacon has.
dBeaconName :: Lens' Diagnostics (Maybe Text) #
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) #
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 #
Response to ListBeaconAttachments that contains the requested attachments.
See: listBeaconAttachmentsResponse smart constructor.
listBeaconAttachmentsResponse :: ListBeaconAttachmentsResponse #
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] #
The attachments that corresponded to the request params.
IndoorLevel
data IndoorLevel #
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
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 #
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.
ephemeralIdRegistrationParams :: EphemeralIdRegistrationParams #
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) #
Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
eirpMaxRotationPeriodExponent :: Lens' EphemeralIdRegistrationParams (Maybe Word32) #
Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent
eirpServiceEcdhPublicKey :: Lens' EphemeralIdRegistrationParams (Maybe ByteString) #
The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange.
BeaconInfo
data BeaconInfo #
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
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] #
Attachments matching the type(s) requested. May be empty if no attachment types were requested, or if none matched.
biBeaconName :: Lens' BeaconInfo (Maybe Text) #
The name under which the beacon is registered.
biAdvertisedId :: Lens' BeaconInfo (Maybe AdvertisedId) #
The ID advertised by the beacon.
Observation
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) #
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 Text) #
Time when the beacon was observed.
oAdvertisedId :: Lens' Observation (Maybe AdvertisedId) #
The ID advertised by the beacon the client has encountered. Clients may submit an Eddystone-EID `advertised_id`. If the client is not authorized to resolve the given Eddystone-EID, no data will be returned for that beacon. Required.
BeaconAttachment
data BeaconAttachment #
Project-specific data associated with a beacon.
See: beaconAttachment smart constructor.
beaconAttachment :: BeaconAttachment #
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:
baData :: Lens' BeaconAttachment (Maybe ByteString) #
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) #
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) #
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 #
Response that contains the requested diagnostics.
See: listDiagnosticsResponse smart constructor.
listDiagnosticsResponse :: ListDiagnosticsResponse #
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) #
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] #
The diagnostics matching the given request.
AdvertisedId
data AdvertisedId #
Defines a unique identifier of a beacon as broadcast by the device.
See: advertisedId smart constructor.
Instances
advertisedId :: AdvertisedId #
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) #
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.
ListBeaconsResponse
data ListBeaconsResponse #
Response that contains list beacon results and pagination help.
See: listBeaconsResponse smart constructor.
listBeaconsResponse :: ListBeaconsResponse #
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) #
An opaque pagination token that the client may provide in their next request to retrieve the next page of results.
lbrBeacons :: Lens' ListBeaconsResponse [Beacon] #
The beacons that matched the search criteria.
lbrTotalCount :: Lens' ListBeaconsResponse (Maybe Int64) #
Estimate of the total number of beacons matched by the query. Higher values may be less accurate.
GetInfoForObservedBeaconsResponse
data GetInfoForObservedBeaconsResponse #
Information about the requested beacons, optionally including attachment data.
See: getInfoForObservedBeaconsResponse smart constructor.
Instances
getInfoForObservedBeaconsResponse :: GetInfoForObservedBeaconsResponse #
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] #
Public information about beacons. May be empty if the request matched no beacons.