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

Class GetPositionResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotwireless.model.IotWirelessResponse

software.amazon.awssdk.services.iotwireless.model.GetPositionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPositionResponse.Builder,GetPositionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetPositionResponse.Builder

Method Summary

Modifier and Type	Method	Description
Accuracy	accuracy()	The accuracy of the estimated position in meters.
static GetPositionResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPosition()	For responses, this returns true if the service returned a value for the Position property.
List<Float>	position()	The position information of the resource.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPositionResponse.Builder>	serializableBuilderClass()
PositionSolverProvider	solverProvider()	The vendor of the positioning solver.
String	solverProviderAsString()	The vendor of the positioning solver.
PositionSolverType	solverType()	The type of solver used to identify the position of the resource.
String	solverTypeAsString()	The type of solver used to identify the position of the resource.
String	solverVersion()	The version of the positioning solver.
String	timestamp()	The timestamp at which the device's position was determined.
GetPositionResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotwireless.model.IotWirelessResponse

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

hasPosition

public final boolean hasPosition()

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

position

public final List<Float> position()

The position information of the resource.

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

Returns:

The position information of the resource.

accuracy

public final Accuracy accuracy()

The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

Returns:

The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

solverType

public final PositionSolverType solverType()

The type of solver used to identify the position of the resource.

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

Returns:

The type of solver used to identify the position of the resource.

See Also:

PositionSolverType

solverTypeAsString

public final String solverTypeAsString()

The type of solver used to identify the position of the resource.

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

Returns:

The type of solver used to identify the position of the resource.

See Also:

PositionSolverType

solverProvider

public final PositionSolverProvider solverProvider()

The vendor of the positioning solver.

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

Returns:

The vendor of the positioning solver.

See Also:

PositionSolverProvider

solverProviderAsString

public final String solverProviderAsString()

The vendor of the positioning solver.

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

Returns:

The vendor of the positioning solver.

See Also:

PositionSolverProvider

solverVersion

public final String solverVersion()

The version of the positioning solver.

Returns:

The version of the positioning solver.

timestamp

public final String timestamp()

The timestamp at which the device's position was determined.

Returns:

The timestamp at which the device's position was determined.

toBuilder

public GetPositionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPositionResponse.Builder,GetPositionResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetPositionResponse.Builder builder()

serializableBuilderClass

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