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

Class PutGeofenceRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.PutGeofenceRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutGeofenceRequest
extends LocationRequest
implements ToCopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutGeofenceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutGeofenceRequest.Builder	builder()
String	collectionName()	The geofence collection to store the geofence in.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	geofenceId()	An identifier for the geofence.
Map<String,String>	geofenceProperties()	Associates one of more properties with the geofence.
GeofenceGeometry	geometry()	Contains the details to specify the position of the geofence.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasGeofenceProperties()	For responses, this returns true if the service returned a value for the GeofenceProperties property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PutGeofenceRequest.Builder>	serializableBuilderClass()
PutGeofenceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

collectionName

public final String collectionName()

The geofence collection to store the geofence in.

Returns:

The geofence collection to store the geofence in.

geofenceId

public final String geofenceId()

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

Returns:

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

geometry

public final 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.

Returns:

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.

hasGeofenceProperties

public final boolean hasGeofenceProperties()

For responses, this returns true if the service returned a value for the GeofenceProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

geofenceProperties

public final 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"

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGeofenceProperties() method.

Returns:

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"

toBuilder

public PutGeofenceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutGeofenceRequest.Builder,PutGeofenceRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static PutGeofenceRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutGeofenceRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo