com.google.maps.routing.v2.RouteModifiersOrBuilder Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/maps/routing/v2/route_modifiers.proto

// Protobuf Java Version: 3.25.3
package com.google.maps.routing.v2;

public interface RouteModifiersOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.maps.routing.v2.RouteModifiers)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * When set to true, avoids toll roads where reasonable, giving preference to
   * routes not containing toll roads. Applies only to the `DRIVE` and
   * `TWO_WHEELER` [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * bool avoid_tolls = 1;
   *
   * @return The avoidTolls.
   */
  boolean getAvoidTolls();

  /**
   *
   *
   *    * When set to true, avoids highways where reasonable, giving preference to
   * routes not containing highways. Applies only to the `DRIVE` and
   * `TWO_WHEELER` [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * bool avoid_highways = 2;
   *
   * @return The avoidHighways.
   */
  boolean getAvoidHighways();

  /**
   *
   *
   *    * When set to true, avoids ferries where reasonable, giving preference to
   * routes not containing ferries. Applies only to the `DRIVE` and`TWO_WHEELER`
   * [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * bool avoid_ferries = 3;
   *
   * @return The avoidFerries.
   */
  boolean getAvoidFerries();

  /**
   *
   *
   *    * When set to true, avoids navigating indoors where reasonable, giving
   * preference to routes not containing indoor navigation. Applies only to the
   * `WALK` [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * bool avoid_indoor = 4;
   *
   * @return The avoidIndoor.
   */
  boolean getAvoidIndoor();

  /**
   *
   *
   *    * Specifies the vehicle information.
   * 
   *
   * .google.maps.routing.v2.VehicleInfo vehicle_info = 5;
   *
   * @return Whether the vehicleInfo field is set.
   */
  boolean hasVehicleInfo();
  /**
   *
   *
   *    * Specifies the vehicle information.
   * 
   *
   * .google.maps.routing.v2.VehicleInfo vehicle_info = 5;
   *
   * @return The vehicleInfo.
   */
  com.google.maps.routing.v2.VehicleInfo getVehicleInfo();
  /**
   *
   *
   *    * Specifies the vehicle information.
   * 
   *
   * .google.maps.routing.v2.VehicleInfo vehicle_info = 5;
   */
  com.google.maps.routing.v2.VehicleInfoOrBuilder getVehicleInfoOrBuilder();

  /**
   *
   *
   *    * Encapsulates information about toll passes.
   * If toll passes are provided, the API tries to return the pass price. If
   * toll passes are not provided, the API treats the toll pass as unknown and
   * tries to return the cash price.
   * Applies only to the `DRIVE` and `TWO_WHEELER`
   * [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * repeated .google.maps.routing.v2.TollPass toll_passes = 6;
   *
   * @return A list containing the tollPasses.
   */
  java.util.List getTollPassesList();
  /**
   *
   *
   *    * Encapsulates information about toll passes.
   * If toll passes are provided, the API tries to return the pass price. If
   * toll passes are not provided, the API treats the toll pass as unknown and
   * tries to return the cash price.
   * Applies only to the `DRIVE` and `TWO_WHEELER`
   * [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * repeated .google.maps.routing.v2.TollPass toll_passes = 6;
   *
   * @return The count of tollPasses.
   */
  int getTollPassesCount();
  /**
   *
   *
   *    * Encapsulates information about toll passes.
   * If toll passes are provided, the API tries to return the pass price. If
   * toll passes are not provided, the API treats the toll pass as unknown and
   * tries to return the cash price.
   * Applies only to the `DRIVE` and `TWO_WHEELER`
   * [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * repeated .google.maps.routing.v2.TollPass toll_passes = 6;
   *
   * @param index The index of the element to return.
   * @return The tollPasses at the given index.
   */
  com.google.maps.routing.v2.TollPass getTollPasses(int index);
  /**
   *
   *
   *    * Encapsulates information about toll passes.
   * If toll passes are provided, the API tries to return the pass price. If
   * toll passes are not provided, the API treats the toll pass as unknown and
   * tries to return the cash price.
   * Applies only to the `DRIVE` and `TWO_WHEELER`
   * [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * repeated .google.maps.routing.v2.TollPass toll_passes = 6;
   *
   * @return A list containing the enum numeric values on the wire for tollPasses.
   */
  java.util.List getTollPassesValueList();
  /**
   *
   *
   *    * Encapsulates information about toll passes.
   * If toll passes are provided, the API tries to return the pass price. If
   * toll passes are not provided, the API treats the toll pass as unknown and
   * tries to return the cash price.
   * Applies only to the `DRIVE` and `TWO_WHEELER`
   * [`RouteTravelMode`][google.maps.routing.v2.RouteTravelMode].
   * 
   *
   * repeated .google.maps.routing.v2.TollPass toll_passes = 6;
   *
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of tollPasses at the given index.
   */
  int getTollPassesValue(int index);
}