Package com.azure.messaging.eventgrid.systemevents

Class MapsGeofenceEventProperties

java.lang.Object

com.azure.messaging.eventgrid.systemevents.MapsGeofenceEventProperties

Direct Known Subclasses:

MapsGeofenceEnteredEventData, MapsGeofenceExitedEventData, MapsGeofenceResultEventData

public class MapsGeofenceEventProperties
extends Object

Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).

Constructor Summary

Constructors

Constructor	Description
MapsGeofenceEventProperties()

Method Summary

Modifier and Type	Method	Description
List<String>	getExpiredGeofenceGeometryId()	Get the expiredGeofenceGeometryId property: Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
List<MapsGeofenceGeometry>	getGeometries()	Get the geometries property: Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
List<String>	getInvalidPeriodGeofenceGeometryId()	Get the invalidPeriodGeofenceGeometryId property: Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
Boolean	isEventPublished()	Get the isEventPublished property: True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.
MapsGeofenceEventProperties	setExpiredGeofenceGeometryId(List<String> expiredGeofenceGeometryId)	Set the expiredGeofenceGeometryId property: Lists of the geometry ID of the geofence which is expired relative to the user time in the request.
MapsGeofenceEventProperties	setGeometries(List<MapsGeofenceGeometry> geometries)	Set the geometries property: Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
MapsGeofenceEventProperties	setInvalidPeriodGeofenceGeometryId(List<String> invalidPeriodGeofenceGeometryId)	Set the invalidPeriodGeofenceGeometryId property: Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
MapsGeofenceEventProperties	setIsEventPublished(Boolean isEventPublished)	Set the isEventPublished property: True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapsGeofenceEventProperties

public MapsGeofenceEventProperties()

Method Detail

getExpiredGeofenceGeometryId

public List<String> getExpiredGeofenceGeometryId()

Get the expiredGeofenceGeometryId property: Lists of the geometry ID of the geofence which is expired relative to the user time in the request.

Returns:

the expiredGeofenceGeometryId value.

setExpiredGeofenceGeometryId

public MapsGeofenceEventProperties setExpiredGeofenceGeometryId(List<String> expiredGeofenceGeometryId)

Set the expiredGeofenceGeometryId property: Lists of the geometry ID of the geofence which is expired relative to the user time in the request.

Parameters:

expiredGeofenceGeometryId - the expiredGeofenceGeometryId value to set.

Returns:

the MapsGeofenceEventProperties object itself.

getGeometries

public List<MapsGeofenceGeometry> getGeometries()

Get the geometries property: Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.

Returns:

the geometries value.

setGeometries

public MapsGeofenceEventProperties setGeometries(List<MapsGeofenceGeometry> geometries)

Set the geometries property: Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.

Parameters:

geometries - the geometries value to set.

Returns:

the MapsGeofenceEventProperties object itself.

getInvalidPeriodGeofenceGeometryId

public List<String> getInvalidPeriodGeofenceGeometryId()

Get the invalidPeriodGeofenceGeometryId property: Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.

Returns:

the invalidPeriodGeofenceGeometryId value.

setInvalidPeriodGeofenceGeometryId

public MapsGeofenceEventProperties setInvalidPeriodGeofenceGeometryId(List<String> invalidPeriodGeofenceGeometryId)

Set the invalidPeriodGeofenceGeometryId property: Lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.

Parameters:

invalidPeriodGeofenceGeometryId - the invalidPeriodGeofenceGeometryId value to set.

Returns:

the MapsGeofenceEventProperties object itself.

isEventPublished

public Boolean isEventPublished()

Get the isEventPublished property: True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.

Returns:

the isEventPublished value.

setIsEventPublished

public MapsGeofenceEventProperties setIsEventPublished(Boolean isEventPublished)

Set the isEventPublished property: True if at least one event is published to the Azure Maps event subscriber, false if no event is published to the Azure Maps event subscriber.

Parameters:

isEventPublished - the isEventPublished value to set.

Returns:

the MapsGeofenceEventProperties object itself.