software.amazon.awssdk.services.location.model

Class GetGeofenceResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.GetGeofenceResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetGeofenceResponse.Builder,GetGeofenceResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetGeofenceResponse
extends LocationResponse
implements ToCopyableBuilder<GetGeofenceResponse.Builder,GetGeofenceResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetGeofenceResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetGeofenceResponse.Builder	builder()
Instant	createTime() The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	geofenceId() The geofence identifier.
Map<String,String>	geofenceProperties() User defined properties of the geofence.
GeofenceGeometry	geometry() Contains the geofence geometry details describing a polygon or a circle.
<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 GetGeofenceResponse.Builder>	serializableBuilderClass()
String	status() Identifies the state of the geofence.
GetGeofenceResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updateTime() The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

createTime

public final Instant createTime()

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

The timestamp for when the geofence collection was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofenceId

public final String 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 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()

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

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

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

public final Instant updateTime()

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

toBuilder

public GetGeofenceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetGeofenceResponse.Builder,GetGeofenceResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetGeofenceResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo