Package com.azure.messaging.eventgrid.systemevents

Class MapsGeofenceEventProperties

java.lang.Object
com.azure.messaging.eventgrid.systemevents.MapsGeofenceEventProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<MapsGeofenceEventProperties>
Direct Known Subclasses:
MapsGeofenceEnteredEventData, MapsGeofenceExitedEventData, MapsGeofenceResultEventData
public class MapsGeofenceEventProperties extends Object implements com.azure.json.JsonSerializable<MapsGeofenceEventProperties>
Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    MapsGeofenceEventProperties(List<String> expiredGeofenceGeometryId, List<MapsGeofenceGeometry> geometries, List<String> invalidPeriodGeofenceGeometryId, boolean isEventPublished)
    Creates an instance of MapsGeofenceEventProperties class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static MapsGeofenceEventProperties
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of MapsGeofenceEventProperties from the JsonReader.
    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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • MapsGeofenceEventProperties

      protected MapsGeofenceEventProperties(List<String> expiredGeofenceGeometryId, List<MapsGeofenceGeometry> geometries, List<String> invalidPeriodGeofenceGeometryId, boolean isEventPublished)
      Creates an instance of MapsGeofenceEventProperties class.
      Parameters:
      expiredGeofenceGeometryId - the expiredGeofenceGeometryId value to set.
      geometries - the geometries value to set.
      invalidPeriodGeofenceGeometryId - the invalidPeriodGeofenceGeometryId value to set.
      isEventPublished - the isEventPublished value to set.

  • Method Details

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

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

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

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

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<MapsGeofenceEventProperties>
      Throws:
      IOException

    • fromJson

      public static MapsGeofenceEventProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of MapsGeofenceEventProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of MapsGeofenceEventProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the MapsGeofenceEventProperties.