software.amazon.awssdk.services.location.model

Class BatchPutGeofenceRequestEntry

java.lang.Object

software.amazon.awssdk.services.location.model.BatchPutGeofenceRequestEntry

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<BatchPutGeofenceRequestEntry.Builder,BatchPutGeofenceRequestEntry>

@Generated(value="software.amazon.awssdk:codegen")
public final class BatchPutGeofenceRequestEntry
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<BatchPutGeofenceRequestEntry.Builder,BatchPutGeofenceRequestEntry>

Contains geofence geometry details.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchPutGeofenceRequestEntry.Builder

Method Summary

Modifier and Type	Method and Description
static BatchPutGeofenceRequestEntry.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	geofenceId() The identifier for the geofence to be stored in a given geofence collection.
Map<String,String>	geofenceProperties() Associates one of more properties with the geofence.
GeofenceGeometry	geometry() Contains the details of 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 BatchPutGeofenceRequestEntry.Builder>	serializableBuilderClass()
BatchPutGeofenceRequestEntry.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

geofenceId

public final String geofenceId()

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

Returns:

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

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"

geometry

public final GeofenceGeometry geometry()

Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.

Returns:

Contains the details of the position of the geofence. Can be either a polygon or a circle. Including both will return a validation error.

Each geofence polygon can have a maximum of 1,000 vertices.

toBuilder

public BatchPutGeofenceRequestEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchPutGeofenceRequestEntry.Builder,BatchPutGeofenceRequestEntry>

builder

public static BatchPutGeofenceRequestEntry.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo