Class ListGeofenceResponseEntry
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ListGeofenceResponseEntry.Builder,
ListGeofenceResponseEntry>
Contains a list of geofences stored in a given geofence collection.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The geofence identifier.User defined properties of the geofence.final GeofenceGeometry
geometry()
Contains the geofence geometry details describing a polygon or a circle.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the GeofenceProperties property.final int
hashCode()
static Class
<? extends ListGeofenceResponseEntry.Builder> final String
status()
Identifies the state of the geofence.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
The timestamp for when the geofence was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createTime
The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
- Returns:
- The timestamp for when the geofence was stored in a geofence collection in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
-
geofenceId
The geofence identifier.
- Returns:
- The geofence identifier.
-
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 theisEmpty()
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
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"
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:
- 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"
-
geometry
Contains the geofence geometry details describing a polygon or a circle.
- Returns:
- Contains the geofence geometry details describing a polygon or a circle.
-
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:
- 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.
-
-
-
updateTime
The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
- Returns:
- The timestamp for when the geofence was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListGeofenceResponseEntry.Builder,
ListGeofenceResponseEntry> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-