xref: /aosp_15_r20/external/googleapis/google/maps/routing/v2/transit.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9) 
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.maps.routing.v2;
18
19import "google/maps/routing/v2/location.proto";
20import "google/type/localized_text.proto";
21
22option cc_enable_arenas = true;
23option csharp_namespace = "Google.Maps.Routing.V2";
24option go_package = "cloud.google.com/go/maps/routing/apiv2/routingpb;routingpb";
25option java_multiple_files = true;
26option java_outer_classname = "TransitProto";
27option java_package = "com.google.maps.routing.v2";
28option objc_class_prefix = "GMRV2";
29option php_namespace = "Google\\Maps\\Routing\\V2";
30option ruby_package = "Google::Maps::Routing::V2";
31
32// A transit agency that operates a transit line.
33message TransitAgency {
34  // The name of this transit agency.
35  string name = 1;
36
37  // The transit agency's locale-specific formatted phone number.
38  string phone_number = 2;
39
40  // The transit agency's URI.
41  string uri = 3;
42}
43
44// Contains information about the transit line used in this step.
45message TransitLine {
46  // The transit agency (or agencies) that operates this transit line.
47  repeated TransitAgency agencies = 1;
48
49  // The full name of this transit line, For example, "8 Avenue Local".
50  string name = 2;
51
52  // the URI for this transit line as provided by the transit agency.
53  string uri = 3;
54
55  // The color commonly used in signage for this line. Represented in
56  // hexadecimal.
57  string color = 4;
58
59  // The URI for the icon associated with this line.
60  string icon_uri = 5;
61
62  // The short name of this transit line. This name will normally be a line
63  // number, such as "M7" or "355".
64  string name_short = 6;
65
66  // The color commonly used in text on signage for this line. Represented in
67  // hexadecimal.
68  string text_color = 7;
69
70  // The type of vehicle that operates on this transit line.
71  TransitVehicle vehicle = 8;
72}
73
74// Information about a transit stop.
75message TransitStop {
76  // The name of the transit stop.
77  string name = 1;
78
79  // The location of the stop expressed in latitude/longitude coordinates.
80  Location location = 2;
81}
82
83// Information about a vehicle used in transit routes.
84message TransitVehicle {
85  // The type of vehicles for transit routes.
86  enum TransitVehicleType {
87    // Unused.
88    TRANSIT_VEHICLE_TYPE_UNSPECIFIED = 0;
89
90    // Bus.
91    BUS = 1;
92
93    // A vehicle that operates on a cable, usually on the ground. Aerial cable
94    // cars may be of the type `GONDOLA_LIFT`.
95    CABLE_CAR = 2;
96
97    // Commuter rail.
98    COMMUTER_TRAIN = 3;
99
100    // Ferry.
101    FERRY = 4;
102
103    // A vehicle that is pulled up a steep incline by a cable. A Funicular
104    // typically consists of two cars, with each car acting as a counterweight
105    // for the other.
106    FUNICULAR = 5;
107
108    // An aerial cable car.
109    GONDOLA_LIFT = 6;
110
111    // Heavy rail.
112    HEAVY_RAIL = 7;
113
114    // High speed train.
115    HIGH_SPEED_TRAIN = 8;
116
117    // Intercity bus.
118    INTERCITY_BUS = 9;
119
120    // Long distance train.
121    LONG_DISTANCE_TRAIN = 10;
122
123    // Light rail transit.
124    METRO_RAIL = 11;
125
126    // Monorail.
127    MONORAIL = 12;
128
129    // All other vehicles.
130    OTHER = 13;
131
132    // Rail.
133    RAIL = 14;
134
135    // Share taxi is a kind of bus with the ability to drop off and pick up
136    // passengers anywhere on its route.
137    SHARE_TAXI = 15;
138
139    // Underground light rail.
140    SUBWAY = 16;
141
142    // Above ground light rail.
143    TRAM = 17;
144
145    // Trolleybus.
146    TROLLEYBUS = 18;
147  }
148
149  // The name of this vehicle, capitalized.
150  google.type.LocalizedText name = 1;
151
152  // The type of vehicle used.
153  TransitVehicleType type = 2;
154
155  // The URI for an icon associated with this vehicle type.
156  string icon_uri = 3;
157
158  // The URI for the icon associated with this vehicle type, based on the local
159  // transport signage.
160  string local_icon_uri = 4;
161}
162