Class CalculateIsolinesResponse

    • Method Detail

      • arrivalTime

        public final String arrivalTime()

        Time of arrival at the destination. This parameter is returned only if the Destination parameters was provided in the request.

        Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

        Examples:

        2020-04-22T17:57:24Z

        2020-04-22T17:57:24+02:00

        Returns:
        Time of arrival at the destination. This parameter is returned only if the Destination parameters was provided in the request.

        Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

        Examples:

        2020-04-22T17:57:24Z

        2020-04-22T17:57:24+02:00

      • departureTime

        public final String departureTime()

        Time of departure from thr origin.

        Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

        Examples:

        2020-04-22T17:57:24Z

        2020-04-22T17:57:24+02:00

        Returns:
        Time of departure from thr origin.

        Time format:YYYY-MM-DDThh:mm:ss.sssZ | YYYY-MM-DDThh:mm:ss.sss+hh:mm

        Examples:

        2020-04-22T17:57:24Z

        2020-04-22T17:57:24+02:00

      • isolineGeometryFormat

        public final GeometryFormat isolineGeometryFormat()

        The format of the returned IsolineGeometry.

        Default Value:FlexiblePolyline

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

        Returns:
        The format of the returned IsolineGeometry.

        Default Value:FlexiblePolyline

        See Also:
        GeometryFormat
      • isolineGeometryFormatAsString

        public final String isolineGeometryFormatAsString()

        The format of the returned IsolineGeometry.

        Default Value:FlexiblePolyline

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

        Returns:
        The format of the returned IsolineGeometry.

        Default Value:FlexiblePolyline

        See Also:
        GeometryFormat
      • hasIsolines

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

        public final List<Isoline> isolines()

        Calculated isolines and associated properties.

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

        Returns:
        Calculated isolines and associated properties.
      • 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.
      • hasSnappedDestination

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

        public final List<Double> snappedDestination()

        Snapped destination that was used for the Isoline 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 hasSnappedDestination() method.

        Returns:
        Snapped destination that was used for the Isoline calculation.
      • hasSnappedOrigin

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

        public final List<Double> snappedOrigin()

        Snapped origin that was used for the Isoline 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 hasSnappedOrigin() method.

        Returns:
        Snapped origin that was used for the Isoline calculation.
      • 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