Package software.amazon.awssdk.services.location.model

Interface BatchPutGeofenceRequestEntry.Builder

All Superinterfaces:

Buildable, CopyableBuilder<BatchPutGeofenceRequestEntry.Builder,BatchPutGeofenceRequestEntry>, SdkBuilder<BatchPutGeofenceRequestEntry.Builder,BatchPutGeofenceRequestEntry>, SdkPojo

Enclosing class:

BatchPutGeofenceRequestEntry

public static interface BatchPutGeofenceRequestEntry.Builder
extends SdkPojo, CopyableBuilder<BatchPutGeofenceRequestEntry.Builder,BatchPutGeofenceRequestEntry>

Method Summary

Modifier and Type	Method	Description
BatchPutGeofenceRequestEntry.Builder	geofenceId(String geofenceId)	The identifier for the geofence to be stored in a given geofence collection.
BatchPutGeofenceRequestEntry.Builder	geofenceProperties(Map<String,String> geofenceProperties)	Associates one of more properties with the geofence.
default BatchPutGeofenceRequestEntry.Builder	geometry(Consumer<GeofenceGeometry.Builder> geometry)	Contains the details to specify the position of the geofence.
BatchPutGeofenceRequestEntry.Builder	geometry(GeofenceGeometry geometry)	Contains the details to specify the position of the geofence.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

geofenceId

BatchPutGeofenceRequestEntry.Builder geofenceId(String geofenceId)

The identifier for the geofence to be stored in a given geofence collection.

Parameters:

geofenceId - The identifier for the geofence to be stored in a given geofence collection.

Returns:

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

geometry

BatchPutGeofenceRequestEntry.Builder geometry(GeofenceGeometry geometry)

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices.

Parameters:

geometry - Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices.

Returns:

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

geometry

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

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence geobuf format supports a maximum of 100,000 vertices.

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:

geometry(GeofenceGeometry)

geofenceProperties

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

Associates one of more properties with 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 - Associates one of more properties with 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.