Package software.amazon.awssdk.services.iotwireless.model

Class GetPositionEstimateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotwireless.model.IotWirelessRequest

software.amazon.awssdk.services.iotwireless.model.GetPositionEstimateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPositionEstimateRequest.Builder,GetPositionEstimateRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetPositionEstimateRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetPositionEstimateRequest.Builder	builder()
CellTowers	cellTowers()	Retrieves an estimated device position by resolving measurement data from cellular radio towers.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
Gnss	gnss()	Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data.
int	hashCode()
boolean	hasWiFiAccessPoints()	For responses, this returns true if the service returned a value for the WiFiAccessPoints property.
Ip	ip()	Retrieves an estimated device position by resolving the IP address information from the device.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPositionEstimateRequest.Builder>	serializableBuilderClass()
Instant	timestamp()	Optional information that specifies the time when the position information will be resolved.
GetPositionEstimateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<WiFiAccessPoint>	wiFiAccessPoints()	Retrieves an estimated device position by resolving WLAN measurement data.

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

hasWiFiAccessPoints

public final boolean hasWiFiAccessPoints()

For responses, this returns true if the service returned a value for the WiFiAccessPoints 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.

wiFiAccessPoints

public final List<WiFiAccessPoint> wiFiAccessPoints()

Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

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 hasWiFiAccessPoints() method.

Returns:

Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

cellTowers

public final CellTowers cellTowers()

Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

Returns:

Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

ip

public final Ip ip()

Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

Returns:

Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

gnss

public final Gnss gnss()

Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.

Returns:

Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.

timestamp

public final Instant timestamp()

Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

Returns:

Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

toBuilder

public GetPositionEstimateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPositionEstimateRequest.Builder,GetPositionEstimateRequest>

Specified by:

toBuilder in class IotWirelessRequest

builder

public static GetPositionEstimateRequest.Builder builder()

serializableBuilderClass

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