com.microsoft.azure.eventgrid.models

Class MapsGeofenceEventProperties

java.lang.Object

com.microsoft.azure.eventgrid.models.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 and Description
MapsGeofenceEventProperties()

Method Summary

Modifier and Type	Method and Description
List<String>	expiredGeofenceGeometryId() Get lists of the geometry ID of the geofence which is expired relative to the user time in the request.
List<MapsGeofenceGeometry>	geometries() Get lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
List<String>	invalidPeriodGeofenceGeometryId() Get lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
Boolean	isEventPublished() Get 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	withExpiredGeofenceGeometryId(List<String> expiredGeofenceGeometryId) Set lists of the geometry ID of the geofence which is expired relative to the user time in the request.
MapsGeofenceEventProperties	withGeometries(List<MapsGeofenceGeometry> geometries) Set lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.
MapsGeofenceEventProperties	withInvalidPeriodGeofenceGeometryId(List<String> invalidPeriodGeofenceGeometryId) Set lists of the geometry ID of the geofence which is in invalid period relative to the user time in the request.
MapsGeofenceEventProperties	withIsEventPublished(Boolean isEventPublished) Set 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

expiredGeofenceGeometryId

public List<String> expiredGeofenceGeometryId()

Get lists of the geometry ID of the geofence which is expired relative to the user time in the request.

Returns:

the expiredGeofenceGeometryId value

withExpiredGeofenceGeometryId

public MapsGeofenceEventProperties withExpiredGeofenceGeometryId(List<String> expiredGeofenceGeometryId)

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

geometries

public List<MapsGeofenceGeometry> geometries()

Get 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

withGeometries

public MapsGeofenceEventProperties withGeometries(List<MapsGeofenceGeometry> geometries)

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

invalidPeriodGeofenceGeometryId

public List<String> invalidPeriodGeofenceGeometryId()

Get 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

withInvalidPeriodGeofenceGeometryId

public MapsGeofenceEventProperties withInvalidPeriodGeofenceGeometryId(List<String> invalidPeriodGeofenceGeometryId)

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

withIsEventPublished

public MapsGeofenceEventProperties withIsEventPublished(Boolean isEventPublished)

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