程序包 ai.nextbillion.maps

类 DistanceMatrixApiRequest

java.lang.Object
ai.nextbillion.maps.DistanceMatrixApiRequest
所有已实现的接口:
PendingResult<DistanceMatrix>
public class DistanceMatrixApiRequest
extends java.lang.Object
A request to the Distance Matrix API.

  • 构造器详细资料

  • 方法详细资料

    • validateRequest

      protected void validateRequest()

    • origins

      public DistanceMatrixApiRequest origins​(java.lang.String... origins)
      One or more addresses from which to calculate distance and time. The service will geocode the strings and convert them to latitude/longitude coordinates to calculate directions.
      参数:
      origins - Strings to geocode and use as an origin point (e.g. "New York, NY")
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • origins

      public DistanceMatrixApiRequest origins​(LatLng... points)
      One or more latitude/longitude values from which to calculate distance and time.
      参数:
      points - The origin points.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • destinations

      public DistanceMatrixApiRequest destinations​(java.lang.String... destinations)
      One or more addresses to which to calculate distance and time. The service will geocode the strings and convert them to latitude/longitude coordinates to calculate directions.
      参数:
      destinations - Strings to geocode and use as a destination point (e.g. "Jersey City, NJ")
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • destinations

      public DistanceMatrixApiRequest destinations​(LatLng... points)
      One or more latitude/longitude values to which to calculate distance and time.
      参数:
      points - The destination points.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • mode

      public DistanceMatrixApiRequest mode​(TravelMode mode)
      Specifies the mode of transport to use when calculating directions.

      Note that Distance Matrix requests only support TravelMode.DRIVING, TravelMode.WALKING and TravelMode.BICYCLING.

      参数:
      mode - One of the travel modes supported by the Distance Matrix API.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • avoid

      public DistanceMatrixApiRequest avoid​(DirectionsApi.RouteRestriction restriction)
      Introduces restrictions to the route. Only one restriction can be specified.
      参数:
      restriction - One of DirectionsApi.RouteRestriction.TOLLS, DirectionsApi.RouteRestriction.FERRIES or DirectionsApi.RouteRestriction.HIGHWAYS.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • units

      public DistanceMatrixApiRequest units​(Unit unit)
      Specifies the unit system to use when expressing distance as text. Distance Matrix results contain text within distance fields to indicate the distance of the calculated route.
      参数:
      unit - One of Unit.METRIC or Unit.IMPERIAL.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.
      另请参阅:
      Unit systems in the Distance Matrix API

    • departureTime

      public DistanceMatrixApiRequest departureTime​(java.time.Instant departureTime)
      Specifies the desired time of departure.

      The departure time may be specified in two cases:

      • For requests where the travel mode is transit: You can optionally specify one of departure_time or arrival_time. If neither time is specified, the departure_time defaults to now. (That is, the departure time defaults to the current time.)
      • For requests where the travel mode is driving: Google Maps API for Work customers can specify the departure_time to receive trip duration considering current traffic conditions. The departure_time must be set to within a few minutes of the current time.

      Setting the parameter to null will remove it from the API request.

      参数:
      departureTime - The time of departure.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • trafficModel

      public DistanceMatrixApiRequest trafficModel​(TrafficModel trafficModel)
      Specifies the assumptions to use when calculating time in traffic. This parameter may only be specified when the travel mode is driving and the request includes a departure_time.
      参数:
      trafficModel - The traffic model to use in estimating time in traffic.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • arrivalTime

      public DistanceMatrixApiRequest arrivalTime​(java.time.Instant arrivalTime)
      Specifies the desired time of arrival for transit requests. You can specify either departure_time or arrival_time, but not both.
      参数:
      arrivalTime - The preferred arrival time.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • transitModes

      public DistanceMatrixApiRequest transitModes​(TransitMode... transitModes)
      Specifies one or more preferred modes of transit. This parameter may only be specified for requests where the mode is transit.
      参数:
      transitModes - The preferred transit modes.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • transitRoutingPreference

      public DistanceMatrixApiRequest transitRoutingPreference​(TransitRoutingPreference pref)
      Specifies preferences for transit requests. Using this parameter, you can bias the options returned, rather than accepting the default best route chosen by the API.
      参数:
      pref - The transit routing preference for this distance matrix.
      返回:
      Returns this DistanceMatrixApiRequest for call chaining.

    • context

      public DistanceMatrixApiRequest context​(java.lang.String context)

    • setCallback

      public final void setCallback​(PendingResult.Callback<T> callback)
      从接口复制的说明: PendingResult
      Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
      指定者:
      setCallback 在接口中 PendingResult<T>
      参数:
      callback - The callback to call on completion.

    • await

      public final T await() throws ApiException, java.lang.InterruptedException, java.io.IOException
      从接口复制的说明: PendingResult
      Performs the request synchronously.
      指定者:
      await 在接口中 PendingResult<T>
      返回:
      The result.
      抛出:
      ApiException - Thrown if the API Returned result is an error.
      java.lang.InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted.
      java.io.IOException - Thrown when an I/O exception of some sort has occurred.

    • awaitIgnoreError

      public final T awaitIgnoreError()
      从接口复制的说明: PendingResult
      Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
      指定者:
      awaitIgnoreError 在接口中 PendingResult<T>
      返回:
      The result, or null if there was any error or exception ignored.

    • cancel

      public final void cancel()
      从接口复制的说明: PendingResult
      Attempts to cancel the request.
      指定者:
      cancel 在接口中 PendingResult<T>

    • param

      protected A param​(java.lang.String key, java.lang.String val)

    • param

      protected A param​(java.lang.String key, int val)

    • param

      protected A param​(java.lang.String key, StringJoin.UrlValue val)

    • paramAddToList

      protected A paramAddToList​(java.lang.String key, java.lang.String val)

    • paramAddToList

      protected A paramAddToList​(java.lang.String key, StringJoin.UrlValue val)

    • params

      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> params()

    • language

      public final A language​(java.lang.String language)
      The language in which to return results. Note that we often update supported languages so this list may not be exhaustive.
      参数:
      language - The language code, e.g. "en-AU" or "es".
      返回:
      Returns the request for call chaining.
      另请参阅:
      List of supported domain languages

    • channel

      public A channel​(java.lang.String channel)
      A channel to pass with the request. channel is used by Google Maps API for Work users to be able to track usage across different applications with the same clientID. See Premium Plan Usage Rates and Limits.
      参数:
      channel - String to pass with the request for analytics.
      返回:
      Returns the request for call chaining.

    • custom

      public A custom​(java.lang.String parameter, java.lang.String value)
      Custom parameter. For advanced usage only.
      参数:
      parameter - The name of the custom parameter.
      value - The value of the custom parameter.
      返回:
      Returns the request for call chaining.