Class SnapToRoadsResponse

    • Method Detail

      • hasNotices

        public final boolean hasNotices()
        For responses, this returns true if the service returned a value for the Notices 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.
      • notices

        public final List<RoadSnapNotice> notices()

        Notices are additional information returned that indicate issues that occurred during route calculation.

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

        Returns:
        Notices are additional information returned that indicate issues that occurred during route calculation.
      • pricingBucket

        public final String pricingBucket()

        The pricing bucket for which the query is charged at.

        Returns:
        The pricing bucket for which the query is charged at.
      • snappedGeometry

        public final RoadSnapSnappedGeometry snappedGeometry()

        The interpolated geometry for the snapped route onto the road network.

        Returns:
        The interpolated geometry for the snapped route onto the road network.
      • snappedGeometryFormat

        public final GeometryFormat snappedGeometryFormat()

        Specifies the format of the geometry returned for each leg of the route.

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

        Returns:
        Specifies the format of the geometry returned for each leg of the route.
        See Also:
        GeometryFormat
      • snappedGeometryFormatAsString

        public final String snappedGeometryFormatAsString()

        Specifies the format of the geometry returned for each leg of the route.

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

        Returns:
        Specifies the format of the geometry returned for each leg of the route.
        See Also:
        GeometryFormat
      • hasSnappedTracePoints

        public final boolean hasSnappedTracePoints()
        For responses, this returns true if the service returned a value for the SnappedTracePoints 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.
      • snappedTracePoints

        public final List<RoadSnapSnappedTracePoint> snappedTracePoints()

        The trace points snapped onto the road network.

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

        Returns:
        The trace points snapped onto the road network.
      • 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