Class: Google::Apis::ProximitybeaconV1beta1::Beacon

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/proximitybeacon_v1beta1/classes.rb,
generated/google/apis/proximitybeacon_v1beta1/representations.rb,
generated/google/apis/proximitybeacon_v1beta1/representations.rb

Overview

Details of a beacon device.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Beacon

Returns a new instance of Beacon



209
210
211
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 209

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#advertised_id ⇒ Google::Apis::ProximitybeaconV1beta1::AdvertisedId

Defines a unique identifier of a beacon as broadcast by the device. Corresponds to the JSON property advertisedId

Returns:



110
111
112
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 110

def advertised_id
  @advertised_id
end

#beacon_name ⇒ String

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. Corresponds to the JSON property beaconName

Returns:

  • (String) 


120
121
122
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 120

def beacon_name
  @beacon_name
end

#description ⇒ String

Free text used to identify and describe the beacon. Maximum length 140 characters. Optional. Corresponds to the JSON property description

Returns:

  • (String) 


127
128
129
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 127

def description
  @description
end

#ephemeral_id_registration ⇒ Google::Apis::ProximitybeaconV1beta1::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. Corresponds to the JSON property ephemeralIdRegistration

Returns:



151
152
153
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 151

def ephemeral_id_registration
  @ephemeral_id_registration
end

#expected_stability ⇒ String

Expected location stability. This is set when the beacon is registered or updated, not automatically detected in any way. Optional. Corresponds to the JSON property expectedStability

Returns:

  • (String) 


158
159
160
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 158

def expected_stability
  @expected_stability
end

#indoor_level ⇒ Google::Apis::ProximitybeaconV1beta1::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. Corresponds to the JSON property indoorLevel

Returns:



164
165
166
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 164

def indoor_level
  @indoor_level
end

#lat_lng ⇒ Google::Apis::ProximitybeaconV1beta1::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. Corresponds to the JSON property latLng

Returns:



173
174
175
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 173

def lat_lng
  @lat_lng
end

#place_id ⇒ String

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. Corresponds to the JSON property placeId

Returns:

  • (String) 


181
182
183
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 181

def place_id
  @place_id
end

#properties ⇒ Hash<String,String>

Properties of the beacon device, for example battery type or firmware version. Optional. Corresponds to the JSON property properties

Returns:

  • (Hash<String,String>) 


188
189
190
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 188

def properties
  @properties
end

#provisioning_key ⇒ String

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. Corresponds to the JSON property provisioningKey NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


201
202
203
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 201

def provisioning_key
  @provisioning_key
end

#status ⇒ String

Current status of the beacon. Required. Corresponds to the JSON property status

Returns:

  • (String) 


207
208
209
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 207

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'generated/google/apis/proximitybeacon_v1beta1/classes.rb', line 214

def update!(**args)
  @advertised_id = args[:advertised_id] if args.key?(:advertised_id)
  @beacon_name = args[:beacon_name] if args.key?(:beacon_name)
  @description = args[:description] if args.key?(:description)
  @ephemeral_id_registration = args[:ephemeral_id_registration] if args.key?(:ephemeral_id_registration)
  @expected_stability = args[:expected_stability] if args.key?(:expected_stability)
  @indoor_level = args[:indoor_level] if args.key?(:indoor_level)
  @lat_lng = args[:lat_lng] if args.key?(:lat_lng)
  @place_id = args[:place_id] if args.key?(:place_id)
  @properties = args[:properties] if args.key?(:properties)
  @provisioning_key = args[:provisioning_key] if args.key?(:provisioning_key)
  @status = args[:status] if args.key?(:status)
end