com.google.maps.routeoptimization.v1.TransitionAttributesOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-maps-routeoptimization-v1 Show documentation
Proto library for google-maps-routeoptimization
The newest version!
/*
 * 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/routeoptimization/v1/route_optimization_service.proto

// Protobuf Java Version: 3.25.5
package com.google.maps.routeoptimization.v1;

public interface TransitionAttributesOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.maps.routeoptimization.v1.TransitionAttributes)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Tags defining the set of (src->dst) transitions these attributes apply to.
   *
   * A source visit or vehicle start matches iff its
   * [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
   * or
   * [Vehicle.start_tags][google.maps.routeoptimization.v1.Vehicle.start_tags]
   * either contains `src_tag` or does not contain `excluded_src_tag` (depending
   * on which of these two fields is non-empty).
   * 
   *
   * string src_tag = 1;
   *
   * @return The srcTag.
   */
  java.lang.String getSrcTag();
  /**
   *
   *
   *    * Tags defining the set of (src->dst) transitions these attributes apply to.
   *
   * A source visit or vehicle start matches iff its
   * [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
   * or
   * [Vehicle.start_tags][google.maps.routeoptimization.v1.Vehicle.start_tags]
   * either contains `src_tag` or does not contain `excluded_src_tag` (depending
   * on which of these two fields is non-empty).
   * 
   *
   * string src_tag = 1;
   *
   * @return The bytes for srcTag.
   */
  com.google.protobuf.ByteString getSrcTagBytes();

  /**
   *
   *
   *    * See `src_tag`. Exactly one of `src_tag` and `excluded_src_tag` must be
   * non-empty.
   * 
   *
   * string excluded_src_tag = 2;
   *
   * @return The excludedSrcTag.
   */
  java.lang.String getExcludedSrcTag();
  /**
   *
   *
   *    * See `src_tag`. Exactly one of `src_tag` and `excluded_src_tag` must be
   * non-empty.
   * 
   *
   * string excluded_src_tag = 2;
   *
   * @return The bytes for excludedSrcTag.
   */
  com.google.protobuf.ByteString getExcludedSrcTagBytes();

  /**
   *
   *
   *    * A destination visit or vehicle end matches iff its
   * [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
   * or [Vehicle.end_tags][google.maps.routeoptimization.v1.Vehicle.end_tags]
   * either contains `dst_tag` or does not contain `excluded_dst_tag` (depending
   * on which of these two fields is non-empty).
   * 
   *
   * string dst_tag = 3;
   *
   * @return The dstTag.
   */
  java.lang.String getDstTag();
  /**
   *
   *
   *    * A destination visit or vehicle end matches iff its
   * [VisitRequest.tags][google.maps.routeoptimization.v1.Shipment.VisitRequest.tags]
   * or [Vehicle.end_tags][google.maps.routeoptimization.v1.Vehicle.end_tags]
   * either contains `dst_tag` or does not contain `excluded_dst_tag` (depending
   * on which of these two fields is non-empty).
   * 
   *
   * string dst_tag = 3;
   *
   * @return The bytes for dstTag.
   */
  com.google.protobuf.ByteString getDstTagBytes();

  /**
   *
   *
   *    * See `dst_tag`. Exactly one of `dst_tag` and `excluded_dst_tag` must be
   * non-empty.
   * 
   *
   * string excluded_dst_tag = 4;
   *
   * @return The excludedDstTag.
   */
  java.lang.String getExcludedDstTag();
  /**
   *
   *
   *    * See `dst_tag`. Exactly one of `dst_tag` and `excluded_dst_tag` must be
   * non-empty.
   * 
   *
   * string excluded_dst_tag = 4;
   *
   * @return The bytes for excludedDstTag.
   */
  com.google.protobuf.ByteString getExcludedDstTagBytes();

  /**
   *
   *
   *    * Specifies a cost for performing this transition. This is in the same unit
   * as all other costs in the model and must not be negative. It is applied on
   * top of all other existing costs.
   * 
   *
   * double cost = 5;
   *
   * @return The cost.
   */
  double getCost();

  /**
   *
   *
   *    * Specifies a cost per kilometer applied to the distance traveled while
   * performing this transition. It adds up to any
   * [Vehicle.cost_per_kilometer][google.maps.routeoptimization.v1.Vehicle.cost_per_kilometer]
   * specified on vehicles.
   * 
   *
   * double cost_per_kilometer = 6;
   *
   * @return The costPerKilometer.
   */
  double getCostPerKilometer();

  /**
   *
   *
   *    * Specifies a limit on the distance traveled while performing this
   * transition.
   *
   * As of 2021/06, only soft limits are supported.
   * 
   *
   * .google.maps.routeoptimization.v1.DistanceLimit distance_limit = 7;
   *
   * @return Whether the distanceLimit field is set.
   */
  boolean hasDistanceLimit();
  /**
   *
   *
   *    * Specifies a limit on the distance traveled while performing this
   * transition.
   *
   * As of 2021/06, only soft limits are supported.
   * 
   *
   * .google.maps.routeoptimization.v1.DistanceLimit distance_limit = 7;
   *
   * @return The distanceLimit.
   */
  com.google.maps.routeoptimization.v1.DistanceLimit getDistanceLimit();
  /**
   *
   *
   *    * Specifies a limit on the distance traveled while performing this
   * transition.
   *
   * As of 2021/06, only soft limits are supported.
   * 
   *
   * .google.maps.routeoptimization.v1.DistanceLimit distance_limit = 7;
   */
  com.google.maps.routeoptimization.v1.DistanceLimitOrBuilder getDistanceLimitOrBuilder();

  /**
   *
   *
   *    * Specifies a delay incurred when performing this transition.
   *
   * This delay always occurs *after* finishing the source visit and *before*
   * starting the destination visit.
   * 
   *
   * .google.protobuf.Duration delay = 8;
   *
   * @return Whether the delay field is set.
   */
  boolean hasDelay();
  /**
   *
   *
   *    * Specifies a delay incurred when performing this transition.
   *
   * This delay always occurs *after* finishing the source visit and *before*
   * starting the destination visit.
   * 
   *
   * .google.protobuf.Duration delay = 8;
   *
   * @return The delay.
   */
  com.google.protobuf.Duration getDelay();
  /**
   *
   *
   *    * Specifies a delay incurred when performing this transition.
   *
   * This delay always occurs *after* finishing the source visit and *before*
   * starting the destination visit.
   * 
   *
   * .google.protobuf.Duration delay = 8;
   */
  com.google.protobuf.DurationOrBuilder getDelayOrBuilder();
}