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

Interface PutGeofenceRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>, LocationRequest.Builder, SdkBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutGeofenceRequest

public static interface PutGeofenceRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>

Method Summary

Modifier and Type	Method	Description
PutGeofenceRequest.Builder	collectionName(String collectionName)	The geofence collection to store the geofence in.
PutGeofenceRequest.Builder	geofenceId(String geofenceId)	An identifier for the geofence.
PutGeofenceRequest.Builder	geofenceProperties(Map<String,String> geofenceProperties)	Associates one of more properties with the geofence.
default PutGeofenceRequest.Builder	geometry(Consumer<GeofenceGeometry.Builder> geometry)	Contains the details to specify the position of the geofence.
PutGeofenceRequest.Builder	geometry(GeofenceGeometry geometry)	Contains the details to specify the position of the geofence.
PutGeofenceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutGeofenceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder

build

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

collectionName

PutGeofenceRequest.Builder collectionName(String collectionName)

The geofence collection to store the geofence in.

Parameters:

collectionName - The geofence collection to store the geofence in.

Returns:

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

geofenceId

PutGeofenceRequest.Builder geofenceId(String geofenceId)

An identifier for the geofence. For example, ExampleGeofence-1.

Parameters:

geofenceId - An identifier for the geofence. For example, ExampleGeofence-1.

Returns:

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

geometry

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

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

overrideConfiguration

PutGeofenceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutGeofenceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder