1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/maps/routing/v2/routes_service.proto 18 19 package com.google.maps.routing.v2; 20 21 public interface ComputeRoutesRequestOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.maps.routing.v2.ComputeRoutesRequest) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. Origin waypoint. 31 * </pre> 32 * 33 * <code>.google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED]; 34 * </code> 35 * 36 * @return Whether the origin field is set. 37 */ hasOrigin()38 boolean hasOrigin(); 39 /** 40 * 41 * 42 * <pre> 43 * Required. Origin waypoint. 44 * </pre> 45 * 46 * <code>.google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED]; 47 * </code> 48 * 49 * @return The origin. 50 */ getOrigin()51 com.google.maps.routing.v2.Waypoint getOrigin(); 52 /** 53 * 54 * 55 * <pre> 56 * Required. Origin waypoint. 57 * </pre> 58 * 59 * <code>.google.maps.routing.v2.Waypoint origin = 1 [(.google.api.field_behavior) = REQUIRED]; 60 * </code> 61 */ getOriginOrBuilder()62 com.google.maps.routing.v2.WaypointOrBuilder getOriginOrBuilder(); 63 64 /** 65 * 66 * 67 * <pre> 68 * Required. Destination waypoint. 69 * </pre> 70 * 71 * <code> 72 * .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED]; 73 * </code> 74 * 75 * @return Whether the destination field is set. 76 */ hasDestination()77 boolean hasDestination(); 78 /** 79 * 80 * 81 * <pre> 82 * Required. Destination waypoint. 83 * </pre> 84 * 85 * <code> 86 * .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED]; 87 * </code> 88 * 89 * @return The destination. 90 */ getDestination()91 com.google.maps.routing.v2.Waypoint getDestination(); 92 /** 93 * 94 * 95 * <pre> 96 * Required. Destination waypoint. 97 * </pre> 98 * 99 * <code> 100 * .google.maps.routing.v2.Waypoint destination = 2 [(.google.api.field_behavior) = REQUIRED]; 101 * </code> 102 */ getDestinationOrBuilder()103 com.google.maps.routing.v2.WaypointOrBuilder getDestinationOrBuilder(); 104 105 /** 106 * 107 * 108 * <pre> 109 * Optional. A set of waypoints along the route (excluding terminal points), 110 * for either stopping at or passing by. Up to 25 intermediate waypoints are 111 * supported. 112 * </pre> 113 * 114 * <code> 115 * repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL]; 116 * </code> 117 */ getIntermediatesList()118 java.util.List<com.google.maps.routing.v2.Waypoint> getIntermediatesList(); 119 /** 120 * 121 * 122 * <pre> 123 * Optional. A set of waypoints along the route (excluding terminal points), 124 * for either stopping at or passing by. Up to 25 intermediate waypoints are 125 * supported. 126 * </pre> 127 * 128 * <code> 129 * repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL]; 130 * </code> 131 */ getIntermediates(int index)132 com.google.maps.routing.v2.Waypoint getIntermediates(int index); 133 /** 134 * 135 * 136 * <pre> 137 * Optional. A set of waypoints along the route (excluding terminal points), 138 * for either stopping at or passing by. Up to 25 intermediate waypoints are 139 * supported. 140 * </pre> 141 * 142 * <code> 143 * repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL]; 144 * </code> 145 */ getIntermediatesCount()146 int getIntermediatesCount(); 147 /** 148 * 149 * 150 * <pre> 151 * Optional. A set of waypoints along the route (excluding terminal points), 152 * for either stopping at or passing by. Up to 25 intermediate waypoints are 153 * supported. 154 * </pre> 155 * 156 * <code> 157 * repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL]; 158 * </code> 159 */ 160 java.util.List<? extends com.google.maps.routing.v2.WaypointOrBuilder> getIntermediatesOrBuilderList()161 getIntermediatesOrBuilderList(); 162 /** 163 * 164 * 165 * <pre> 166 * Optional. A set of waypoints along the route (excluding terminal points), 167 * for either stopping at or passing by. Up to 25 intermediate waypoints are 168 * supported. 169 * </pre> 170 * 171 * <code> 172 * repeated .google.maps.routing.v2.Waypoint intermediates = 3 [(.google.api.field_behavior) = OPTIONAL]; 173 * </code> 174 */ getIntermediatesOrBuilder(int index)175 com.google.maps.routing.v2.WaypointOrBuilder getIntermediatesOrBuilder(int index); 176 177 /** 178 * 179 * 180 * <pre> 181 * Optional. Specifies the mode of transportation. 182 * </pre> 183 * 184 * <code> 185 * .google.maps.routing.v2.RouteTravelMode travel_mode = 4 [(.google.api.field_behavior) = OPTIONAL]; 186 * </code> 187 * 188 * @return The enum numeric value on the wire for travelMode. 189 */ getTravelModeValue()190 int getTravelModeValue(); 191 /** 192 * 193 * 194 * <pre> 195 * Optional. Specifies the mode of transportation. 196 * </pre> 197 * 198 * <code> 199 * .google.maps.routing.v2.RouteTravelMode travel_mode = 4 [(.google.api.field_behavior) = OPTIONAL]; 200 * </code> 201 * 202 * @return The travelMode. 203 */ getTravelMode()204 com.google.maps.routing.v2.RouteTravelMode getTravelMode(); 205 206 /** 207 * 208 * 209 * <pre> 210 * Optional. Specifies how to compute the route. The server 211 * attempts to use the selected routing preference to compute the route. If 212 * the routing preference results in an error or an extra long latency, then 213 * an error is returned. You can specify this option only when the 214 * `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails. 215 * </pre> 216 * 217 * <code> 218 * .google.maps.routing.v2.RoutingPreference routing_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; 219 * </code> 220 * 221 * @return The enum numeric value on the wire for routingPreference. 222 */ getRoutingPreferenceValue()223 int getRoutingPreferenceValue(); 224 /** 225 * 226 * 227 * <pre> 228 * Optional. Specifies how to compute the route. The server 229 * attempts to use the selected routing preference to compute the route. If 230 * the routing preference results in an error or an extra long latency, then 231 * an error is returned. You can specify this option only when the 232 * `travel_mode` is `DRIVE` or `TWO_WHEELER`, otherwise the request fails. 233 * </pre> 234 * 235 * <code> 236 * .google.maps.routing.v2.RoutingPreference routing_preference = 5 [(.google.api.field_behavior) = OPTIONAL]; 237 * </code> 238 * 239 * @return The routingPreference. 240 */ getRoutingPreference()241 com.google.maps.routing.v2.RoutingPreference getRoutingPreference(); 242 243 /** 244 * 245 * 246 * <pre> 247 * Optional. Specifies your preference for the quality of the polyline. 248 * </pre> 249 * 250 * <code> 251 * .google.maps.routing.v2.PolylineQuality polyline_quality = 6 [(.google.api.field_behavior) = OPTIONAL]; 252 * </code> 253 * 254 * @return The enum numeric value on the wire for polylineQuality. 255 */ getPolylineQualityValue()256 int getPolylineQualityValue(); 257 /** 258 * 259 * 260 * <pre> 261 * Optional. Specifies your preference for the quality of the polyline. 262 * </pre> 263 * 264 * <code> 265 * .google.maps.routing.v2.PolylineQuality polyline_quality = 6 [(.google.api.field_behavior) = OPTIONAL]; 266 * </code> 267 * 268 * @return The polylineQuality. 269 */ getPolylineQuality()270 com.google.maps.routing.v2.PolylineQuality getPolylineQuality(); 271 272 /** 273 * 274 * 275 * <pre> 276 * Optional. Specifies the preferred encoding for the polyline. 277 * </pre> 278 * 279 * <code> 280 * .google.maps.routing.v2.PolylineEncoding polyline_encoding = 12 [(.google.api.field_behavior) = OPTIONAL]; 281 * </code> 282 * 283 * @return The enum numeric value on the wire for polylineEncoding. 284 */ getPolylineEncodingValue()285 int getPolylineEncodingValue(); 286 /** 287 * 288 * 289 * <pre> 290 * Optional. Specifies the preferred encoding for the polyline. 291 * </pre> 292 * 293 * <code> 294 * .google.maps.routing.v2.PolylineEncoding polyline_encoding = 12 [(.google.api.field_behavior) = OPTIONAL]; 295 * </code> 296 * 297 * @return The polylineEncoding. 298 */ getPolylineEncoding()299 com.google.maps.routing.v2.PolylineEncoding getPolylineEncoding(); 300 301 /** 302 * 303 * 304 * <pre> 305 * Optional. The departure time. If you don't set this value, then this value 306 * defaults to the time that you made the request. If you set this value to a 307 * time that has already occurred, then the request fails. 308 * </pre> 309 * 310 * <code>.google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL]; 311 * </code> 312 * 313 * @return Whether the departureTime field is set. 314 */ hasDepartureTime()315 boolean hasDepartureTime(); 316 /** 317 * 318 * 319 * <pre> 320 * Optional. The departure time. If you don't set this value, then this value 321 * defaults to the time that you made the request. If you set this value to a 322 * time that has already occurred, then the request fails. 323 * </pre> 324 * 325 * <code>.google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL]; 326 * </code> 327 * 328 * @return The departureTime. 329 */ getDepartureTime()330 com.google.protobuf.Timestamp getDepartureTime(); 331 /** 332 * 333 * 334 * <pre> 335 * Optional. The departure time. If you don't set this value, then this value 336 * defaults to the time that you made the request. If you set this value to a 337 * time that has already occurred, then the request fails. 338 * </pre> 339 * 340 * <code>.google.protobuf.Timestamp departure_time = 7 [(.google.api.field_behavior) = OPTIONAL]; 341 * </code> 342 */ getDepartureTimeOrBuilder()343 com.google.protobuf.TimestampOrBuilder getDepartureTimeOrBuilder(); 344 345 /** 346 * 347 * 348 * <pre> 349 * Optional. Specifies whether to calculate alternate routes in addition to 350 * the route. No alternative routes are returned for requests that have 351 * intermediate waypoints. 352 * </pre> 353 * 354 * <code>bool compute_alternative_routes = 8 [(.google.api.field_behavior) = OPTIONAL];</code> 355 * 356 * @return The computeAlternativeRoutes. 357 */ getComputeAlternativeRoutes()358 boolean getComputeAlternativeRoutes(); 359 360 /** 361 * 362 * 363 * <pre> 364 * Optional. A set of conditions to satisfy that affect the way routes are 365 * calculated. 366 * </pre> 367 * 368 * <code> 369 * .google.maps.routing.v2.RouteModifiers route_modifiers = 9 [(.google.api.field_behavior) = OPTIONAL]; 370 * </code> 371 * 372 * @return Whether the routeModifiers field is set. 373 */ hasRouteModifiers()374 boolean hasRouteModifiers(); 375 /** 376 * 377 * 378 * <pre> 379 * Optional. A set of conditions to satisfy that affect the way routes are 380 * calculated. 381 * </pre> 382 * 383 * <code> 384 * .google.maps.routing.v2.RouteModifiers route_modifiers = 9 [(.google.api.field_behavior) = OPTIONAL]; 385 * </code> 386 * 387 * @return The routeModifiers. 388 */ getRouteModifiers()389 com.google.maps.routing.v2.RouteModifiers getRouteModifiers(); 390 /** 391 * 392 * 393 * <pre> 394 * Optional. A set of conditions to satisfy that affect the way routes are 395 * calculated. 396 * </pre> 397 * 398 * <code> 399 * .google.maps.routing.v2.RouteModifiers route_modifiers = 9 [(.google.api.field_behavior) = OPTIONAL]; 400 * </code> 401 */ getRouteModifiersOrBuilder()402 com.google.maps.routing.v2.RouteModifiersOrBuilder getRouteModifiersOrBuilder(); 403 404 /** 405 * 406 * 407 * <pre> 408 * Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more 409 * information, see 410 * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See 411 * [Language Support](https://developers.google.com/maps/faq#languagesupport) 412 * for the list of supported languages. When you don't provide this value, the 413 * display language is inferred from the location of the route request. 414 * </pre> 415 * 416 * <code>string language_code = 10 [(.google.api.field_behavior) = OPTIONAL];</code> 417 * 418 * @return The languageCode. 419 */ getLanguageCode()420 java.lang.String getLanguageCode(); 421 /** 422 * 423 * 424 * <pre> 425 * Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more 426 * information, see 427 * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. See 428 * [Language Support](https://developers.google.com/maps/faq#languagesupport) 429 * for the list of supported languages. When you don't provide this value, the 430 * display language is inferred from the location of the route request. 431 * </pre> 432 * 433 * <code>string language_code = 10 [(.google.api.field_behavior) = OPTIONAL];</code> 434 * 435 * @return The bytes for languageCode. 436 */ getLanguageCodeBytes()437 com.google.protobuf.ByteString getLanguageCodeBytes(); 438 439 /** 440 * 441 * 442 * <pre> 443 * Optional. The region code, specified as a ccTLD ("top-level domain") 444 * two-character value. For more information see 445 * https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains 446 * </pre> 447 * 448 * <code>string region_code = 16 [(.google.api.field_behavior) = OPTIONAL];</code> 449 * 450 * @return The regionCode. 451 */ getRegionCode()452 java.lang.String getRegionCode(); 453 /** 454 * 455 * 456 * <pre> 457 * Optional. The region code, specified as a ccTLD ("top-level domain") 458 * two-character value. For more information see 459 * https://en.wikipedia.org/wiki/List_of_Internet_top-level_domains#Country_code_top-level_domains 460 * </pre> 461 * 462 * <code>string region_code = 16 [(.google.api.field_behavior) = OPTIONAL];</code> 463 * 464 * @return The bytes for regionCode. 465 */ getRegionCodeBytes()466 com.google.protobuf.ByteString getRegionCodeBytes(); 467 468 /** 469 * 470 * 471 * <pre> 472 * Optional. Specifies the units of measure for the display fields. This 473 * includes the `instruction` field in 474 * [NavigationInstruction][google.maps.routing.v2.NavigationInstruction]. The 475 * units of measure used for the route, leg, step distance, and duration are 476 * not affected by this value. If you don't provide this value, then the 477 * display units are inferred from the location of the request. 478 * </pre> 479 * 480 * <code>.google.maps.routing.v2.Units units = 11 [(.google.api.field_behavior) = OPTIONAL]; 481 * </code> 482 * 483 * @return The enum numeric value on the wire for units. 484 */ getUnitsValue()485 int getUnitsValue(); 486 /** 487 * 488 * 489 * <pre> 490 * Optional. Specifies the units of measure for the display fields. This 491 * includes the `instruction` field in 492 * [NavigationInstruction][google.maps.routing.v2.NavigationInstruction]. The 493 * units of measure used for the route, leg, step distance, and duration are 494 * not affected by this value. If you don't provide this value, then the 495 * display units are inferred from the location of the request. 496 * </pre> 497 * 498 * <code>.google.maps.routing.v2.Units units = 11 [(.google.api.field_behavior) = OPTIONAL]; 499 * </code> 500 * 501 * @return The units. 502 */ getUnits()503 com.google.maps.routing.v2.Units getUnits(); 504 505 /** 506 * 507 * 508 * <pre> 509 * Optional. Specifies what reference routes to calculate as part of the 510 * request in addition to the default route. A reference route is a route with 511 * a different route calculation objective than the default route. For example 512 * a `FUEL_EFFICIENT` reference route calculation takes into account various 513 * parameters that would generate an optimal fuel efficient route. 514 * </pre> 515 * 516 * <code> 517 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL]; 518 * </code> 519 * 520 * @return A list containing the requestedReferenceRoutes. 521 */ 522 java.util.List<com.google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute> getRequestedReferenceRoutesList()523 getRequestedReferenceRoutesList(); 524 /** 525 * 526 * 527 * <pre> 528 * Optional. Specifies what reference routes to calculate as part of the 529 * request in addition to the default route. A reference route is a route with 530 * a different route calculation objective than the default route. For example 531 * a `FUEL_EFFICIENT` reference route calculation takes into account various 532 * parameters that would generate an optimal fuel efficient route. 533 * </pre> 534 * 535 * <code> 536 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL]; 537 * </code> 538 * 539 * @return The count of requestedReferenceRoutes. 540 */ getRequestedReferenceRoutesCount()541 int getRequestedReferenceRoutesCount(); 542 /** 543 * 544 * 545 * <pre> 546 * Optional. Specifies what reference routes to calculate as part of the 547 * request in addition to the default route. A reference route is a route with 548 * a different route calculation objective than the default route. For example 549 * a `FUEL_EFFICIENT` reference route calculation takes into account various 550 * parameters that would generate an optimal fuel efficient route. 551 * </pre> 552 * 553 * <code> 554 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL]; 555 * </code> 556 * 557 * @param index The index of the element to return. 558 * @return The requestedReferenceRoutes at the given index. 559 */ getRequestedReferenceRoutes( int index)560 com.google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute getRequestedReferenceRoutes( 561 int index); 562 /** 563 * 564 * 565 * <pre> 566 * Optional. Specifies what reference routes to calculate as part of the 567 * request in addition to the default route. A reference route is a route with 568 * a different route calculation objective than the default route. For example 569 * a `FUEL_EFFICIENT` reference route calculation takes into account various 570 * parameters that would generate an optimal fuel efficient route. 571 * </pre> 572 * 573 * <code> 574 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL]; 575 * </code> 576 * 577 * @return A list containing the enum numeric values on the wire for requestedReferenceRoutes. 578 */ getRequestedReferenceRoutesValueList()579 java.util.List<java.lang.Integer> getRequestedReferenceRoutesValueList(); 580 /** 581 * 582 * 583 * <pre> 584 * Optional. Specifies what reference routes to calculate as part of the 585 * request in addition to the default route. A reference route is a route with 586 * a different route calculation objective than the default route. For example 587 * a `FUEL_EFFICIENT` reference route calculation takes into account various 588 * parameters that would generate an optimal fuel efficient route. 589 * </pre> 590 * 591 * <code> 592 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ReferenceRoute requested_reference_routes = 14 [(.google.api.field_behavior) = OPTIONAL]; 593 * </code> 594 * 595 * @param index The index of the value to return. 596 * @return The enum numeric value on the wire of requestedReferenceRoutes at the given index. 597 */ getRequestedReferenceRoutesValue(int index)598 int getRequestedReferenceRoutesValue(int index); 599 600 /** 601 * 602 * 603 * <pre> 604 * Optional. A list of extra computations which may be used to complete the 605 * request. Note: These extra computations may return extra fields on the 606 * response. These extra fields must also be specified in the field mask to be 607 * returned in the response. 608 * </pre> 609 * 610 * <code> 611 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL]; 612 * </code> 613 * 614 * @return A list containing the extraComputations. 615 */ 616 java.util.List<com.google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation> getExtraComputationsList()617 getExtraComputationsList(); 618 /** 619 * 620 * 621 * <pre> 622 * Optional. A list of extra computations which may be used to complete the 623 * request. Note: These extra computations may return extra fields on the 624 * response. These extra fields must also be specified in the field mask to be 625 * returned in the response. 626 * </pre> 627 * 628 * <code> 629 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL]; 630 * </code> 631 * 632 * @return The count of extraComputations. 633 */ getExtraComputationsCount()634 int getExtraComputationsCount(); 635 /** 636 * 637 * 638 * <pre> 639 * Optional. A list of extra computations which may be used to complete the 640 * request. Note: These extra computations may return extra fields on the 641 * response. These extra fields must also be specified in the field mask to be 642 * returned in the response. 643 * </pre> 644 * 645 * <code> 646 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL]; 647 * </code> 648 * 649 * @param index The index of the element to return. 650 * @return The extraComputations at the given index. 651 */ getExtraComputations(int index)652 com.google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation getExtraComputations(int index); 653 /** 654 * 655 * 656 * <pre> 657 * Optional. A list of extra computations which may be used to complete the 658 * request. Note: These extra computations may return extra fields on the 659 * response. These extra fields must also be specified in the field mask to be 660 * returned in the response. 661 * </pre> 662 * 663 * <code> 664 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL]; 665 * </code> 666 * 667 * @return A list containing the enum numeric values on the wire for extraComputations. 668 */ getExtraComputationsValueList()669 java.util.List<java.lang.Integer> getExtraComputationsValueList(); 670 /** 671 * 672 * 673 * <pre> 674 * Optional. A list of extra computations which may be used to complete the 675 * request. Note: These extra computations may return extra fields on the 676 * response. These extra fields must also be specified in the field mask to be 677 * returned in the response. 678 * </pre> 679 * 680 * <code> 681 * repeated .google.maps.routing.v2.ComputeRoutesRequest.ExtraComputation extra_computations = 15 [(.google.api.field_behavior) = OPTIONAL]; 682 * </code> 683 * 684 * @param index The index of the value to return. 685 * @return The enum numeric value on the wire of extraComputations at the given index. 686 */ getExtraComputationsValue(int index)687 int getExtraComputationsValue(int index); 688 } 689