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>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<GetPositionResponse.Builder,GetPositionResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.