Interface ListGeofenceResponseEntry.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ListGeofenceResponseEntry.Builder,ListGeofenceResponseEntry>, SdkBuilder<ListGeofenceResponseEntry.Builder,ListGeofenceResponseEntry>, SdkPojo
Enclosing class:
ListGeofenceResponseEntry
@Mutable @NotThreadSafe public static interface ListGeofenceResponseEntry.Builder extends SdkPojo, CopyableBuilder<ListGeofenceResponseEntry.Builder,ListGeofenceResponseEntry>

  • Method Details

    • geofenceId

      ListGeofenceResponseEntry.Builder geofenceId(String geofenceId)

      The geofence identifier.

      Parameters:
      geofenceId - The geofence identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geometry

      ListGeofenceResponseEntry.Builder geometry(GeofenceGeometry geometry)

      Contains the geofence geometry details describing a polygon or a circle.

      Parameters:
      geometry - Contains the geofence geometry details describing a polygon or a circle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geometry

      default ListGeofenceResponseEntry.Builder geometry(Consumer<GeofenceGeometry.Builder> geometry)

      Contains the geofence geometry details describing a polygon or a circle.

      This is a convenience method that creates an instance of the GeofenceGeometry.Builder avoiding the need to create one manually via GeofenceGeometry.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to geometry(GeofenceGeometry).

      Parameters:
      geometry - a consumer that will call methods on GeofenceGeometry.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ListGeofenceResponseEntry.Builder status(String status)

      Identifies the state of the geofence. A geofence will hold one of the following states:

      • ACTIVE — The geofence has been indexed by the system.

      • PENDING — The geofence is being processed by the system.

      • FAILED — The geofence failed to be indexed by the system.

      • DELETED — The geofence has been deleted from the system index.

      • DELETING — The geofence is being deleted from the system index.

      Parameters:
      status - Identifies the state of the geofence. A geofence will hold one of the following states:

      • ACTIVE — The geofence has been indexed by the system.

      • PENDING — The geofence is being processed by the system.

      • FAILED — The geofence failed to be indexed by the system.

      • DELETED — The geofence has been deleted from the system index.

      • DELETING — The geofence is being deleted from the system index.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createTime

      ListGeofenceResponseEntry.Builder createTime(Instant createTime)

      The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

      Parameters:
      createTime - The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updateTime

      ListGeofenceResponseEntry.Builder updateTime(Instant updateTime)

      The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

      Parameters:
      updateTime - The timestamp for when the geofence was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geofenceProperties

      ListGeofenceResponseEntry.Builder geofenceProperties(Map<String,String> geofenceProperties)

      User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

      Format: "key" : "value"

      Parameters:
      geofenceProperties - User defined properties of the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

      Format: "key" : "value"

      Returns:
      Returns a reference to this object so that method calls can be chained together.