gtfs_realtime_bindings library

Classes

Alert
An alert, indicating some sort of incident in the public transit network.
Alert_Cause
Cause of this alert. If cause_detail is included, then Cause must also be included.
Alert_Effect
What is the effect of this problem on the affected entity. If effect_detail is included, then Effect must also be included.
Alert_SeverityLevel
Severity of this alert.
EntitySelector
A selector for an entity in a GTFS feed.
FeedEntity
A definition (or update) of an entity in the transit feed.
FeedHeader
Metadata about a feed, included in feed messages.
FeedHeader_Incrementality
Determines whether the current fetch is incremental. Currently, DIFFERENTIAL mode is unsupported and behavior is unspecified for feeds that use this mode. There are discussions on the GTFS Realtime mailing list around fully specifying the behavior of DIFFERENTIAL mode and the documentation will be updated when those discussions are finalized.
FeedMessage
The contents of a feed message. A feed is a continuous stream of feed messages. Each message in the stream is obtained as a response to an appropriate HTTP GET request. A realtime feed is always defined with relation to an existing GTFS feed. All the entity ids are resolved with respect to the GTFS feed. Note that "required" and "optional" as stated in this file refer to Protocol Buffer cardinality, not semantic cardinality. See reference.md at https://github.com/google/transit/tree/master/gtfs-realtime for field semantic cardinality.
Position
A position.
ReplacementStop
NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
Shape
Describes the physical path that a vehicle takes when it's not part of the (CSV) GTFS, such as for a detour. Shapes belong to Trips, and consist of a sequence of shape points. Tracing the points in order provides the path of the vehicle. Shapes do not need to intercept the location of Stops exactly, but all Stops on a trip should lie within a small distance of the shape for that trip, i.e. close to straight line segments connecting the shape points NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
Stop
Describes a stop which is served by trips. All fields are as described in the GTFS-Static specification. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
Stop_WheelchairBoarding
StopSelector
NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future. Select a stop by stop sequence or by stop_id. At least one of the two values must be provided.
TimeRange
A time interval. The interval is considered active at time 't' if 't' is greater than or equal to the start time and less than the end time.
TranslatedImage
An internationalized image containing per-language versions of a URL linking to an image along with meta information Only one of the images from a message will be retained by consumers. The resolution proceeds as follows:
TranslatedImage_LocalizedImage
TranslatedString
An internationalized message containing per-language versions of a snippet of text or a URL. One of the strings from a message will be picked up. The resolution proceeds as follows:
TranslatedString_Translation
TripDescriptor
A descriptor that identifies an instance of a GTFS trip, or all instances of a trip along a route.
TripDescriptor_ModifiedTripSelector
TripDescriptor_ScheduleRelationship
The relation between this trip and the static schedule. If a trip is done in accordance with temporary schedule, not reflected in GTFS, then it shouldn't be marked as SCHEDULED, but likely as ADDED.
TripModifications
NOTE: This field is still experimental, and subject to change. It may be formally adopted in the future.
TripModifications_Modification
A Modification message replaces a span of n stop times from each affected trip starting at start_stop_selector.
TripModifications_SelectedTrips
TripUpdate
Realtime update of the progress of a vehicle along a trip. Depending on the value of ScheduleRelationship, a TripUpdate can specify:
TripUpdate_StopTimeEvent
Timing information for a single predicted event (either arrival or departure). Timing consists of delay and/or estimated time, and uncertainty.
TripUpdate_StopTimeUpdate
Realtime update for arrival and/or departure events for a given stop on a trip. Updates can be supplied for both past and future events. The producer is allowed, although not required, to drop past events.
TripUpdate_StopTimeUpdate_ScheduleRelationship
The relation between the StopTimeEvents and the static schedule.
TripUpdate_StopTimeUpdate_StopTimeProperties
Provides the updated values for the stop time. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
TripUpdate_TripProperties
Defines updated properties of the trip, such as a new shape_id when there is a detour. Or defines the trip_id, start_date, and start_time of a DUPLICATED trip. NOTE: This message is still experimental, and subject to change. It may be formally adopted in the future.
VehicleDescriptor
Identification information for the vehicle performing the trip.
VehicleDescriptor_WheelchairAccessible
VehiclePosition
Realtime positioning information for a given vehicle.
VehiclePosition_CarriageDetails
Carriage specific details, used for vehicles composed of several carriages This message/field is still experimental, and subject to change. It may be formally adopted in the future.
VehiclePosition_CongestionLevel
Congestion level that is affecting this vehicle.
VehiclePosition_OccupancyStatus
The state of passenger occupancy for the vehicle or carriage. Individual producers may not publish all OccupancyStatus values. Therefore, consumers must not assume that the OccupancyStatus values follow a linear scale. Consumers should represent OccupancyStatus values as the state indicated and intended by the producer. Likewise, producers must use OccupancyStatus values that correspond to actual vehicle occupancy states. For describing passenger occupancy levels on a linear scale, see occupancy_percentage. This field is still experimental, and subject to change. It may be formally adopted in the future.
VehiclePosition_VehicleStopStatus