MapsGeofenceGeometry Class

Package:

com.microsoft.azure.eventgrid.models

Maven Artifact:

com.microsoft.azure:azure-eventgrid:1.3.0

• java.lang.Object
• • com.microsoft.azure.eventgrid.models.MapsGeofenceGeometry

public class MapsGeofenceGeometry

The geofence geometry.

Constructor Summary

Constructor	Description
MapsGeofenceGeometry()

Method Summary

Modifier and Type	Method and Description
java.lang.String	deviceId() Get iD of the device.
java.lang.Double	distance() Get distance from the coordinate to the closest border of the geofence.
java.lang.String	geometryId() Get the unique ID for the geofence geometry.
java.lang.Double	nearestLat() Get latitude of the nearest point of the geometry.
java.lang.Double	nearestLon() Get longitude of the nearest point of the geometry.
java.lang.String	udId() Get the unique id returned from user upload service when uploading a geofence.
MapsGeofenceGeometry	withDeviceId(String deviceId) Set iD of the device.
MapsGeofenceGeometry	withDistance(Double distance) Set distance from the coordinate to the closest border of the geofence.
MapsGeofenceGeometry	withGeometryId(String geometryId) Set the unique ID for the geofence geometry.
MapsGeofenceGeometry	withNearestLat(Double nearestLat) Set latitude of the nearest point of the geometry.
MapsGeofenceGeometry	withNearestLon(Double nearestLon) Set longitude of the nearest point of the geometry.
MapsGeofenceGeometry	withUdId(String udId) Set the unique id returned from user upload service when uploading a geofence.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

MapsGeofenceGeometry

public MapsGeofenceGeometry()

Method Details

deviceId

public String deviceId()

Get iD of the device.

Returns:

the deviceId value

distance

public Double distance()

Get 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

geometryId

public String geometryId()

Get the unique ID for the geofence geometry.

Returns:

the geometryId value

nearestLat

public Double nearestLat()

Get latitude of the nearest point of the geometry.

Returns:

the nearestLat value

nearestLon

public Double nearestLon()

Get longitude of the nearest point of the geometry.

Returns:

the nearestLon value

udId

public String udId()

Get the unique id returned from user upload service when uploading a geofence. Will not be included in geofencing post API.

Returns:

the udId value

withDeviceId

public MapsGeofenceGeometry withDeviceId(String deviceId)

Set iD of the device.

Parameters:

deviceId - the deviceId value to set

Returns:

the MapsGeofenceGeometry object itself.

withDistance

public MapsGeofenceGeometry withDistance(Double distance)

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

withGeometryId

public MapsGeofenceGeometry withGeometryId(String geometryId)

Set the unique ID for the geofence geometry.

Parameters:

geometryId - the geometryId value to set

Returns:

the MapsGeofenceGeometry object itself.

withNearestLat

public MapsGeofenceGeometry withNearestLat(Double nearestLat)

Set latitude of the nearest point of the geometry.

Parameters:

nearestLat - the nearestLat value to set

Returns:

the MapsGeofenceGeometry object itself.

withNearestLon

public MapsGeofenceGeometry withNearestLon(Double nearestLon)

Set longitude of the nearest point of the geometry.

Parameters:

nearestLon - the nearestLon value to set

Returns:

the MapsGeofenceGeometry object itself.

withUdId

public MapsGeofenceGeometry withUdId(String udId)

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