Package software.amazon.awssdk.services.iot.model

Class GeoLocationTarget

java.lang.Object

software.amazon.awssdk.services.iot.model.GeoLocationTarget

All Implemented Interfaces:

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

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

A geolocation target that you select to index. Each geolocation target contains a name and order key-value pair that specifies the geolocation target fields.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeoLocationTarget.Builder

Method Summary

Modifier and Type	Method	Description
static GeoLocationTarget.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the geolocation target field.
TargetFieldOrder	order()	The order of the geolocation target field.
String	orderAsString()	The order of the geolocation target field.
List<SdkField<?>>	sdkFields()
static Class<? extends GeoLocationTarget.Builder>	serializableBuilderClass()
GeoLocationTarget.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

name

public final String name()

The name of the geolocation target field. If the target field is part of a named shadow, you must select the named shadow using the namedShadow filter.

Returns:

The name of the geolocation target field. If the target field is part of a named shadow, you must select the named shadow using the namedShadow filter.

order

public final TargetFieldOrder order()

The order of the geolocation target field. This field is optional. The default value is LatLon.

If the service returns an enum value that is not available in the current SDK version, order will return TargetFieldOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

The order of the geolocation target field. This field is optional. The default value is LatLon.

See Also:

TargetFieldOrder

orderAsString

public final String orderAsString()

The order of the geolocation target field. This field is optional. The default value is LatLon.

If the service returns an enum value that is not available in the current SDK version, order will return TargetFieldOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orderAsString().

Returns:

The order of the geolocation target field. This field is optional. The default value is LatLon.

See Also:

TargetFieldOrder

toBuilder

public GeoLocationTarget.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GeoLocationTarget.Builder,GeoLocationTarget>

builder

public static GeoLocationTarget.Builder builder()

serializableBuilderClass

public static Class<? extends GeoLocationTarget.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