Package com.azure.messaging.eventgrid.systemevents

Class MapsGeofenceGeometry

  • public final class MapsGeofenceGeometry
extends Object
    The geofence geometry.

    • Constructor Detail

      • MapsGeofenceGeometry

        public MapsGeofenceGeometry()

    • Method Detail

      • getDeviceId

        public String getDeviceId()
        Get the deviceId property: ID of the device.
        Returns:
        the deviceId value.

      • setDeviceId

        public MapsGeofenceGeometry setDeviceId​(String deviceId)
        Set the deviceId property: ID of the device.
        Parameters:
        deviceId - the deviceId value to set.
        Returns:
        the MapsGeofenceGeometry object itself.

      • getDistance

        public Float getDistance()
        Get the distance property: Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
        Returns:
        the distance value.

      • setDistance

        public MapsGeofenceGeometry setDistance​(Float distance)
        Set the distance property: Distance from the coordinate to the closest border of the geofence. Positive means the coordinate is outside of the geofence. If the coordinate is outside of the geofence, but more than the value of searchBuffer away from the closest geofence border, then the value is 999. Negative means the coordinate is inside of the geofence. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest geofencing border,then the value is -999. A value of 999 means that there is great confidence the coordinate is well outside the geofence. A value of -999 means that there is great confidence the coordinate is well within the geofence.
        Parameters:
        distance - the distance value to set.
        Returns:
        the MapsGeofenceGeometry object itself.

      • getGeometryId

        public String getGeometryId()
        Get the geometryId property: The unique ID for the geofence geometry.
        Returns:
        the geometryId value.

      • setGeometryId

        public MapsGeofenceGeometry setGeometryId​(String geometryId)
        Set the geometryId property: The unique ID for the geofence geometry.
        Parameters:
        geometryId - the geometryId value to set.
        Returns:
        the MapsGeofenceGeometry object itself.

      • getNearestLat

        public Float getNearestLat()
        Get the nearestLat property: Latitude of the nearest point of the geometry.
        Returns:
        the nearestLat value.

      • setNearestLat

        public MapsGeofenceGeometry setNearestLat​(Float nearestLat)
        Set the nearestLat property: Latitude of the nearest point of the geometry.
        Parameters:
        nearestLat - the nearestLat value to set.
        Returns:
        the MapsGeofenceGeometry object itself.

      • getNearestLon

        public Float getNearestLon()
        Get the nearestLon property: Longitude of the nearest point of the geometry.
        Returns:
        the nearestLon value.

      • setNearestLon

        public MapsGeofenceGeometry setNearestLon​(Float nearestLon)
        Set the nearestLon property: Longitude of the nearest point of the geometry.
        Parameters:
        nearestLon - the nearestLon value to set.
        Returns:
        the MapsGeofenceGeometry object itself.

      • getUdId

        public String getUdId()
        Get the udId property: The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
        Returns:
        the udId value.

      • setUdId

        public MapsGeofenceGeometry setUdId​(String udId)
        Set the udId property: The unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.
        Parameters:
        udId - the udId value to set.
        Returns:
        the MapsGeofenceGeometry object itself.