Package com.google.maps.routing.v2

Interface ComputeRouteMatrixRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ComputeRouteMatrixRequest, ComputeRouteMatrixRequest.Builder
    public interface ComputeRouteMatrixRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getOriginsList

        List<RouteMatrixOrigin> getOriginsList()
         Required. Array of origins, which determines the rows of the response
 matrix. Several size restrictions apply to the cardinality of origins and
 destinations:

 * The number of elements (origins × destinations) must be no greater than
 625 in any case.
 * The number of elements (origins × destinations) must be no greater than
 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
 * The number of waypoints (origins + destinations) specified as `place_id`
 must be no greater than 50.
        repeated .google.maps.routing.v2.RouteMatrixOrigin origins = 1 [(.google.api.field_behavior) = REQUIRED];

      • getOrigins

        RouteMatrixOrigin getOrigins​(int index)
         Required. Array of origins, which determines the rows of the response
 matrix. Several size restrictions apply to the cardinality of origins and
 destinations:

 * The number of elements (origins × destinations) must be no greater than
 625 in any case.
 * The number of elements (origins × destinations) must be no greater than
 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
 * The number of waypoints (origins + destinations) specified as `place_id`
 must be no greater than 50.
        repeated .google.maps.routing.v2.RouteMatrixOrigin origins = 1 [(.google.api.field_behavior) = REQUIRED];

      • getOriginsCount

        int getOriginsCount()
         Required. Array of origins, which determines the rows of the response
 matrix. Several size restrictions apply to the cardinality of origins and
 destinations:

 * The number of elements (origins × destinations) must be no greater than
 625 in any case.
 * The number of elements (origins × destinations) must be no greater than
 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
 * The number of waypoints (origins + destinations) specified as `place_id`
 must be no greater than 50.
        repeated .google.maps.routing.v2.RouteMatrixOrigin origins = 1 [(.google.api.field_behavior) = REQUIRED];

      • getOriginsOrBuilderList

        List<? extends RouteMatrixOriginOrBuilder> getOriginsOrBuilderList()
         Required. Array of origins, which determines the rows of the response
 matrix. Several size restrictions apply to the cardinality of origins and
 destinations:

 * The number of elements (origins × destinations) must be no greater than
 625 in any case.
 * The number of elements (origins × destinations) must be no greater than
 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
 * The number of waypoints (origins + destinations) specified as `place_id`
 must be no greater than 50.
        repeated .google.maps.routing.v2.RouteMatrixOrigin origins = 1 [(.google.api.field_behavior) = REQUIRED];

      • getOriginsOrBuilder

        RouteMatrixOriginOrBuilder getOriginsOrBuilder​(int index)
         Required. Array of origins, which determines the rows of the response
 matrix. Several size restrictions apply to the cardinality of origins and
 destinations:

 * The number of elements (origins × destinations) must be no greater than
 625 in any case.
 * The number of elements (origins × destinations) must be no greater than
 100 if routing_preference is set to `TRAFFIC_AWARE_OPTIMAL`.
 * The number of waypoints (origins + destinations) specified as `place_id`
 must be no greater than 50.
        repeated .google.maps.routing.v2.RouteMatrixOrigin origins = 1 [(.google.api.field_behavior) = REQUIRED];

      • getDestinationsList

        List<RouteMatrixDestination> getDestinationsList()
         Required. Array of destinations, which determines the columns of the
 response matrix.
        repeated .google.maps.routing.v2.RouteMatrixDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

      • getDestinations

        RouteMatrixDestination getDestinations​(int index)
         Required. Array of destinations, which determines the columns of the
 response matrix.
        repeated .google.maps.routing.v2.RouteMatrixDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

      • getDestinationsCount

        int getDestinationsCount()
         Required. Array of destinations, which determines the columns of the
 response matrix.
        repeated .google.maps.routing.v2.RouteMatrixDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

      • getDestinationsOrBuilderList

        List<? extends RouteMatrixDestinationOrBuilder> getDestinationsOrBuilderList()
         Required. Array of destinations, which determines the columns of the
 response matrix.
        repeated .google.maps.routing.v2.RouteMatrixDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

      • getDestinationsOrBuilder

        RouteMatrixDestinationOrBuilder getDestinationsOrBuilder​(int index)
         Required. Array of destinations, which determines the columns of the
 response matrix.
        repeated .google.maps.routing.v2.RouteMatrixDestination destinations = 2 [(.google.api.field_behavior) = REQUIRED];

      • getTravelModeValue

        int getTravelModeValue()
         Optional. Specifies the mode of transportation.
        .google.maps.routing.v2.RouteTravelMode travel_mode = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for travelMode.

      • getTravelMode

        RouteTravelMode getTravelMode()
         Optional. Specifies the mode of transportation.
        .google.maps.routing.v2.RouteTravelMode travel_mode = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The travelMode.

      • getRoutingPreferenceValue

        int getRoutingPreferenceValue()
         Optional. Specifies how to compute the route. The server attempts to use
 the selected routing preference to compute the route. If the routing
 preference results in an error or an extra long latency, an error is
 returned. You can specify this option only when the `travel_mode` is
 `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
        .google.maps.routing.v2.RoutingPreference routing_preference = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for routingPreference.

      • getRoutingPreference

        RoutingPreference getRoutingPreference()
         Optional. Specifies how to compute the route. The server attempts to use
 the selected routing preference to compute the route. If the routing
 preference results in an error or an extra long latency, an error is
 returned. You can specify this option only when the `travel_mode` is
 `DRIVE` or `TWO_WHEELER`, otherwise the request fails.
        .google.maps.routing.v2.RoutingPreference routing_preference = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The routingPreference.

      • hasDepartureTime

        boolean hasDepartureTime()
         Optional. The departure time. If you don't set this value, then this value
 defaults to the time that you made the request.
 NOTE: You can only specify a `departure_time` in the past when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.protobuf.Timestamp departure_time = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the departureTime field is set.

      • getDepartureTime

        com.google.protobuf.Timestamp getDepartureTime()
         Optional. The departure time. If you don't set this value, then this value
 defaults to the time that you made the request.
 NOTE: You can only specify a `departure_time` in the past when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.protobuf.Timestamp departure_time = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The departureTime.

      • getDepartureTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getDepartureTimeOrBuilder()
         Optional. The departure time. If you don't set this value, then this value
 defaults to the time that you made the request.
 NOTE: You can only specify a `departure_time` in the past when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.protobuf.Timestamp departure_time = 5 [(.google.api.field_behavior) = OPTIONAL];

      • hasArrivalTime

        boolean hasArrivalTime()
         Optional. The arrival time.
 NOTE: Can only be set when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`. You can specify either departure_time or arrival_time, but not
 both.
        .google.protobuf.Timestamp arrival_time = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the arrivalTime field is set.

      • getArrivalTime

        com.google.protobuf.Timestamp getArrivalTime()
         Optional. The arrival time.
 NOTE: Can only be set when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`. You can specify either departure_time or arrival_time, but not
 both.
        .google.protobuf.Timestamp arrival_time = 11 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The arrivalTime.

      • getArrivalTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getArrivalTimeOrBuilder()
         Optional. The arrival time.
 NOTE: Can only be set when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`. You can specify either departure_time or arrival_time, but not
 both.
        .google.protobuf.Timestamp arrival_time = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getLanguageCode

        String getLanguageCode()
         Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see
 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See
 [Language Support](https://developers.google.com/maps/faq#languagesupport)
 for the list of supported languages. When you don't provide this value, the
 display language is inferred from the location of the first origin.
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        com.google.protobuf.ByteString getLanguageCodeBytes()
         Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more
 information, see
 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See
 [Language Support](https://developers.google.com/maps/faq#languagesupport)
 for the list of supported languages. When you don't provide this value, the
 display language is inferred from the location of the first origin.
        string language_code = 6 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for languageCode.

      • getRegionCode

        String getRegionCode()
         Optional. The region code, specified as a ccTLD ("top-level domain")
 two-character value. For more information see
 https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains
        string region_code = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The regionCode.

      • getRegionCodeBytes

        com.google.protobuf.ByteString getRegionCodeBytes()
         Optional. The region code, specified as a ccTLD ("top-level domain")
 two-character value. For more information see
 https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains
        string region_code = 9 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The bytes for regionCode.

      • getExtraComputationsList

        List<ComputeRouteMatrixRequest.ExtraComputation> getExtraComputationsList()
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRouteMatrixRequest.ExtraComputation extra_computations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the extraComputations.

      • getExtraComputationsCount

        int getExtraComputationsCount()
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRouteMatrixRequest.ExtraComputation extra_computations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The count of extraComputations.

      • getExtraComputations

        ComputeRouteMatrixRequest.ExtraComputation getExtraComputations​(int index)
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRouteMatrixRequest.ExtraComputation extra_computations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the element to return.
        Returns:
        The extraComputations at the given index.

      • getExtraComputationsValueList

        List<Integer> getExtraComputationsValueList()
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRouteMatrixRequest.ExtraComputation extra_computations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        A list containing the enum numeric values on the wire for extraComputations.

      • getExtraComputationsValue

        int getExtraComputationsValue​(int index)
         Optional. A list of extra computations which may be used to complete the
 request. Note: These extra computations may return extra fields on the
 response. These extra fields must also be specified in the field mask to be
 returned in the response.
        repeated .google.maps.routing.v2.ComputeRouteMatrixRequest.ExtraComputation extra_computations = 8 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        index - The index of the value to return.
        Returns:
        The enum numeric value on the wire of extraComputations at the given index.

      • getTrafficModelValue

        int getTrafficModelValue()
         Optional. Specifies the assumptions to use when calculating time in
 traffic. This setting affects the value returned in the duration field in
 the [RouteMatrixElement][google.maps.routing.v2.RouteMatrixElement] which
 contains the predicted time in traffic based on historical averages.
 [RoutingPreference][google.maps.routing.v2.RoutingPreference] to
 `TRAFFIC_AWARE_OPTIMAL` and
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to `DRIVE`.
 Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
 specified.
        .google.maps.routing.v2.TrafficModel traffic_model = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The enum numeric value on the wire for trafficModel.

      • getTrafficModel

        TrafficModel getTrafficModel()
         Optional. Specifies the assumptions to use when calculating time in
 traffic. This setting affects the value returned in the duration field in
 the [RouteMatrixElement][google.maps.routing.v2.RouteMatrixElement] which
 contains the predicted time in traffic based on historical averages.
 [RoutingPreference][google.maps.routing.v2.RoutingPreference] to
 `TRAFFIC_AWARE_OPTIMAL` and
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] to `DRIVE`.
 Defaults to `BEST_GUESS` if traffic is requested and `TrafficModel` is not
 specified.
        .google.maps.routing.v2.TrafficModel traffic_model = 10 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The trafficModel.

      • hasTransitPreferences

        boolean hasTransitPreferences()
         Optional. Specifies preferences that influence the route returned for
 `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.maps.routing.v2.TransitPreferences transit_preferences = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        Whether the transitPreferences field is set.

      • getTransitPreferences

        TransitPreferences getTransitPreferences()
         Optional. Specifies preferences that influence the route returned for
 `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.maps.routing.v2.TransitPreferences transit_preferences = 12 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        The transitPreferences.

      • getTransitPreferencesOrBuilder

        TransitPreferencesOrBuilder getTransitPreferencesOrBuilder()
         Optional. Specifies preferences that influence the route returned for
 `TRANSIT` routes. NOTE: You can only specify a `transit_preferences` when
 [RouteTravelMode][google.maps.routing.v2.RouteTravelMode] is set to
 `TRANSIT`.
        .google.maps.routing.v2.TransitPreferences transit_preferences = 12 [(.google.api.field_behavior) = OPTIONAL];