path_apiv1

package
v0.0.0-...-3018eca Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2024 License: MIT Imports: 12 Imported by: 0

README

Source API protos

curl https://raw.githubusercontent.com/mrazza/path-data/master/proto/common.proto > common.proto
curl https://raw.githubusercontent.com/mrazza/path-data/master/proto/routes.proto > routes.proto
curl https://raw.githubusercontent.com/mrazza/path-data/master/proto/server.proto > server.proto
curl https://raw.githubusercontent.com/mrazza/path-data/master/proto/stations.proto > stations.proto

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Station_name = map[int32]string{
		0: "STATION_UNSPECIFIED",
		1: "NEWARK",

		2: "HARRISON",

		3: "JOURNAL_SQUARE",

		4: "GROVE_STREET",

		5: "EXCHANGE_PLACE",

		6: "WORLD_TRADE_CENTER",

		7: "NEWPORT",

		8: "HOBOKEN",

		9: "CHRISTOPHER_STREET",

		10: "NINTH_STREET",

		11: "FOURTEENTH_STREET",

		12: "TWENTY_THIRD_STREET",

		13: "THIRTY_THIRD_STREET",
	}
	Station_value = map[string]int32{
		"STATION_UNSPECIFIED": 0,
		"NEWARK":              1,
		"newark":              1,
		"HARRISON":            2,
		"harrison":            2,
		"JOURNAL_SQUARE":      3,
		"journal_square":      3,
		"GROVE_STREET":        4,
		"grove_street":        4,
		"EXCHANGE_PLACE":      5,
		"exchange_place":      5,
		"WORLD_TRADE_CENTER":  6,
		"world_trade_center":  6,
		"NEWPORT":             7,
		"newport":             7,
		"HOBOKEN":             8,
		"hoboken":             8,
		"CHRISTOPHER_STREET":  9,
		"christopher_street":  9,
		"NINTH_STREET":        10,
		"ninth_street":        10,
		"FOURTEENTH_STREET":   11,
		"fourteenth_street":   11,
		"TWENTY_THIRD_STREET": 12,
		"twenty_third_street": 12,
		"THIRTY_THIRD_STREET": 13,
		"thirty_third_street": 13,
	}
)

Enum value maps for Station.

View Source
var (
	Route_name = map[int32]string{
		0: "ROUTE_UNSPECIFIED",
		1: "JSQ_33_HOB",

		2: "HOB_33",

		3: "HOB_WTC",

		4: "JSQ_33",

		5: "NWK_WTC",

		6: "NPT_HOB",
	}
	Route_value = map[string]int32{
		"ROUTE_UNSPECIFIED": 0,
		"JSQ_33_HOB":        1,
		"jsq_33_hob":        1,
		"HOB_33":            2,
		"hob_33":            2,
		"HOB_WTC":           3,
		"hob_wtc":           3,
		"JSQ_33":            4,
		"jsq_33":            4,
		"NWK_WTC":           5,
		"nwk_wtc":           5,
		"NPT_HOB":           6,
		"npt_hob":           6,
	}
)

Enum value maps for Route.

View Source
var (
	Direction_name = map[int32]string{
		0: "DIRECTION_UNSPECIFIED",
		1: "TO_NJ",

		2: "TO_NY",
	}
	Direction_value = map[string]int32{
		"DIRECTION_UNSPECIFIED": 0,
		"TO_NJ":                 1,
		"to_nj":                 1,
		"TO_NY":                 2,
		"to_ny":                 2,
	}
)

Enum value maps for Direction.

View Source
var (
	GetUpcomingTrainsResponse_UpcomingTrain_Status_name = map[int32]string{
		0: "STATUS_UNSPECIFIED",
		1: "ON_TIME",
		2: "ARRIVING_NOW",
		3: "DELAYED",
	}
	GetUpcomingTrainsResponse_UpcomingTrain_Status_value = map[string]int32{
		"STATUS_UNSPECIFIED": 0,
		"ON_TIME":            1,
		"ARRIVING_NOW":       2,
		"DELAYED":            3,
	}
)

Enum value maps for GetUpcomingTrainsResponse_UpcomingTrain_Status.

View Source
var File_common_proto protoreflect.FileDescriptor
View Source
var File_routes_proto protoreflect.FileDescriptor
View Source
var File_server_proto protoreflect.FileDescriptor
View Source
var File_stations_proto protoreflect.FileDescriptor
View Source
var Routes_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "path_api.v1.Routes",
	HandlerType: (*RoutesServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListRoutes",
			Handler:    _Routes_ListRoutes_Handler,
		},
		{
			MethodName: "GetRoute",
			Handler:    _Routes_GetRoute_Handler,
		},
		{
			MethodName: "GetRouteSchedule",
			Handler:    _Routes_GetRouteSchedule_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "routes.proto",
}

Routes_ServiceDesc is the grpc.ServiceDesc for Routes service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var Server_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "path_api.v1.Server",
	HandlerType: (*ServerServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetHealth",
			Handler:    _Server_GetHealth_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "server.proto",
}

Server_ServiceDesc is the grpc.ServiceDesc for Server service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source
var Stations_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "path_api.v1.Stations",
	HandlerType: (*StationsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListStations",
			Handler:    _Stations_ListStations_Handler,
		},
		{
			MethodName: "GetStation",
			Handler:    _Stations_GetStation_Handler,
		},
		{
			MethodName: "GetStationSchedule",
			Handler:    _Stations_GetStationSchedule_Handler,
		},
		{
			MethodName: "GetUpcomingTrains",
			Handler:    _Stations_GetUpcomingTrains_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "stations.proto",
}

Stations_ServiceDesc is the grpc.ServiceDesc for Stations service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterRoutesServer

func RegisterRoutesServer(s grpc.ServiceRegistrar, srv RoutesServer)

func RegisterServerServer

func RegisterServerServer(s grpc.ServiceRegistrar, srv ServerServer)

func RegisterStationsServer

func RegisterStationsServer(s grpc.ServiceRegistrar, srv StationsServer)

Types

type Direction

type Direction int32

Directions trains can travel along routes.

const (
	Direction_DIRECTION_UNSPECIFIED Direction = 0
	Direction_TO_NJ                 Direction = 1
	// Deprecated: Do not use.
	Direction_to_nj Direction = 1
	Direction_TO_NY Direction = 2
	// Deprecated: Do not use.
	Direction_to_ny Direction = 2
)

func (Direction) Descriptor

func (Direction) Descriptor() protoreflect.EnumDescriptor

func (Direction) Enum

func (x Direction) Enum() *Direction

func (Direction) EnumDescriptor deprecated

func (Direction) EnumDescriptor() ([]byte, []int)

Deprecated: Use Direction.Descriptor instead.

func (Direction) Number

func (x Direction) Number() protoreflect.EnumNumber

func (Direction) String

func (x Direction) String() string

func (Direction) Type

type GetRouteRequest

type GetRouteRequest struct {

	// The route to get information about.
	Route Route `protobuf:"varint,1,opt,name=route,proto3,enum=path_api.v1.Route" json:"route,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRouteRequest) Descriptor deprecated

func (*GetRouteRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRouteRequest.ProtoReflect.Descriptor instead.

func (*GetRouteRequest) GetRoute

func (x *GetRouteRequest) GetRoute() Route

func (*GetRouteRequest) ProtoMessage

func (*GetRouteRequest) ProtoMessage()

func (*GetRouteRequest) ProtoReflect

func (x *GetRouteRequest) ProtoReflect() protoreflect.Message

func (*GetRouteRequest) Reset

func (x *GetRouteRequest) Reset()

func (*GetRouteRequest) String

func (x *GetRouteRequest) String() string

type GetRouteScheduleRequest

type GetRouteScheduleRequest struct {
	Route Route `protobuf:"varint,1,opt,name=route,proto3,enum=path_api.v1.Route" json:"route,omitempty"`
	// Optional. The maximum number of elements to return for a single request.
	// If unspecified, the server will pick a reasonable default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The page token returned by the server in a previous call. Used
	// to get the next page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRouteScheduleRequest) Descriptor deprecated

func (*GetRouteScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRouteScheduleRequest.ProtoReflect.Descriptor instead.

func (*GetRouteScheduleRequest) GetPageSize

func (x *GetRouteScheduleRequest) GetPageSize() int32

func (*GetRouteScheduleRequest) GetPageToken

func (x *GetRouteScheduleRequest) GetPageToken() string

func (*GetRouteScheduleRequest) GetRoute

func (x *GetRouteScheduleRequest) GetRoute() Route

func (*GetRouteScheduleRequest) ProtoMessage

func (*GetRouteScheduleRequest) ProtoMessage()

func (*GetRouteScheduleRequest) ProtoReflect

func (x *GetRouteScheduleRequest) ProtoReflect() protoreflect.Message

func (*GetRouteScheduleRequest) Reset

func (x *GetRouteScheduleRequest) Reset()

func (*GetRouteScheduleRequest) String

func (x *GetRouteScheduleRequest) String() string

type GetRouteScheduleResponse

type GetRouteScheduleResponse struct {
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRouteScheduleResponse) Descriptor deprecated

func (*GetRouteScheduleResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetRouteScheduleResponse.ProtoReflect.Descriptor instead.

func (*GetRouteScheduleResponse) GetNextPageToken

func (x *GetRouteScheduleResponse) GetNextPageToken() string

func (*GetRouteScheduleResponse) ProtoMessage

func (*GetRouteScheduleResponse) ProtoMessage()

func (*GetRouteScheduleResponse) ProtoReflect

func (x *GetRouteScheduleResponse) ProtoReflect() protoreflect.Message

func (*GetRouteScheduleResponse) Reset

func (x *GetRouteScheduleResponse) Reset()

func (*GetRouteScheduleResponse) String

func (x *GetRouteScheduleResponse) String() string

type GetStationRequest

type GetStationRequest struct {

	// The station to get.
	Station Station `protobuf:"varint,1,opt,name=station,proto3,enum=path_api.v1.Station" json:"station,omitempty"`
	// contains filtered or unexported fields
}

The request message for the get stations RPC

func (*GetStationRequest) Descriptor deprecated

func (*GetStationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStationRequest.ProtoReflect.Descriptor instead.

func (*GetStationRequest) GetStation

func (x *GetStationRequest) GetStation() Station

func (*GetStationRequest) ProtoMessage

func (*GetStationRequest) ProtoMessage()

func (*GetStationRequest) ProtoReflect

func (x *GetStationRequest) ProtoReflect() protoreflect.Message

func (*GetStationRequest) Reset

func (x *GetStationRequest) Reset()

func (*GetStationRequest) String

func (x *GetStationRequest) String() string

type GetStationScheduleRequest

type GetStationScheduleRequest struct {

	// The station for this request.
	Station Station `protobuf:"varint,1,opt,name=station,proto3,enum=path_api.v1.Station" json:"station,omitempty"`
	// Optional. The maximum number of elements to return for a single request.
	// If unspecified, the server will pick a reasonable default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The page token returned by the server in a previous call. Used
	// to get the next page.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request message for the get station schedule RPC.

func (*GetStationScheduleRequest) Descriptor deprecated

func (*GetStationScheduleRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetStationScheduleRequest.ProtoReflect.Descriptor instead.

func (*GetStationScheduleRequest) GetPageSize

func (x *GetStationScheduleRequest) GetPageSize() int32

func (*GetStationScheduleRequest) GetPageToken

func (x *GetStationScheduleRequest) GetPageToken() string

func (*GetStationScheduleRequest) GetStation

func (x *GetStationScheduleRequest) GetStation() Station

func (*GetStationScheduleRequest) ProtoMessage

func (*GetStationScheduleRequest) ProtoMessage()

func (*GetStationScheduleRequest) ProtoReflect

func (*GetStationScheduleRequest) Reset

func (x *GetStationScheduleRequest) Reset()

func (*GetStationScheduleRequest) String

func (x *GetStationScheduleRequest) String() string

type GetStationScheduleResponse

type GetStationScheduleResponse struct {

	// The page token used to request the next page. Empty/unspecified if there
	// are no more results.
	NextPageToken string `protobuf:"bytes,1,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response message for the get station schedule RPC.

func (*GetStationScheduleResponse) Descriptor deprecated

func (*GetStationScheduleResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetStationScheduleResponse.ProtoReflect.Descriptor instead.

func (*GetStationScheduleResponse) GetNextPageToken

func (x *GetStationScheduleResponse) GetNextPageToken() string

func (*GetStationScheduleResponse) ProtoMessage

func (*GetStationScheduleResponse) ProtoMessage()

func (*GetStationScheduleResponse) ProtoReflect

func (*GetStationScheduleResponse) Reset

func (x *GetStationScheduleResponse) Reset()

func (*GetStationScheduleResponse) String

func (x *GetStationScheduleResponse) String() string

type GetUpcomingTrainsRequest

type GetUpcomingTrainsRequest struct {

	// The station for this request.
	Station Station `protobuf:"varint,1,opt,name=station,proto3,enum=path_api.v1.Station" json:"station,omitempty"`
	// contains filtered or unexported fields
}

The request message for the get upcoming (realtime) trains RPC.

func (*GetUpcomingTrainsRequest) Descriptor deprecated

func (*GetUpcomingTrainsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetUpcomingTrainsRequest.ProtoReflect.Descriptor instead.

func (*GetUpcomingTrainsRequest) GetStation

func (x *GetUpcomingTrainsRequest) GetStation() Station

func (*GetUpcomingTrainsRequest) ProtoMessage

func (*GetUpcomingTrainsRequest) ProtoMessage()

func (*GetUpcomingTrainsRequest) ProtoReflect

func (x *GetUpcomingTrainsRequest) ProtoReflect() protoreflect.Message

func (*GetUpcomingTrainsRequest) Reset

func (x *GetUpcomingTrainsRequest) Reset()

func (*GetUpcomingTrainsRequest) String

func (x *GetUpcomingTrainsRequest) String() string

type GetUpcomingTrainsResponse

type GetUpcomingTrainsResponse struct {

	// The collection of upcoming trains.
	UpcomingTrains []*GetUpcomingTrainsResponse_UpcomingTrain `protobuf:"bytes,1,rep,name=upcoming_trains,json=upcomingTrains,proto3" json:"upcoming_trains,omitempty"`
	// contains filtered or unexported fields
}

The response message for the get upcoming (realtime) trains RPC.

func (*GetUpcomingTrainsResponse) Descriptor deprecated

func (*GetUpcomingTrainsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetUpcomingTrainsResponse.ProtoReflect.Descriptor instead.

func (*GetUpcomingTrainsResponse) GetUpcomingTrains

func (*GetUpcomingTrainsResponse) ProtoMessage

func (*GetUpcomingTrainsResponse) ProtoMessage()

func (*GetUpcomingTrainsResponse) ProtoReflect

func (*GetUpcomingTrainsResponse) Reset

func (x *GetUpcomingTrainsResponse) Reset()

func (*GetUpcomingTrainsResponse) String

func (x *GetUpcomingTrainsResponse) String() string

type GetUpcomingTrainsResponse_UpcomingTrain

type GetUpcomingTrainsResponse_UpcomingTrain struct {

	// The headsign for the train in question (e.g. Newark).
	//
	// Deprecated: Do not use.
	LineName string `protobuf:"bytes,1,opt,name=line_name,json=lineName,proto3" json:"line_name,omitempty"`
	// The headsign for the train in question (e.g. Newark).
	Headsign string `protobuf:"bytes,6,opt,name=headsign,proto3" json:"headsign,omitempty"`
	// The route this train is on.
	Route Route `protobuf:"varint,7,opt,name=route,proto3,enum=path_api.v1.Route" json:"route,omitempty"`
	// The display name for the route and direction.
	RouteDisplayName string `protobuf:"bytes,8,opt,name=route_display_name,json=routeDisplayName,proto3" json:"route_display_name,omitempty"`
	// The direction of the train along the route.
	Direction Direction `protobuf:"varint,9,opt,name=direction,proto3,enum=path_api.v1.Direction" json:"direction,omitempty"`
	// The collection of colors (in HTML HEX format) that represent the train line.
	// Usually only a single color applies (orange for JSQ/33rd) but sometimes more
	// than one color applies (33rd via HOB).
	LineColors []string `protobuf:"bytes,2,rep,name=line_colors,json=lineColors,proto3" json:"line_colors,omitempty"`
	// The timestamp (UTC) of the projected arrival of this train.
	ProjectedArrival *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=projected_arrival,json=projectedArrival,proto3" json:"projected_arrival,omitempty"`
	// The status of the train.
	Status GetUpcomingTrainsResponse_UpcomingTrain_Status `` /* 130-byte string literal not displayed */
	// The timestamp (UTC) when this projection was made.
	LastUpdated *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_updated,json=lastUpdated,proto3" json:"last_updated,omitempty"`
	// contains filtered or unexported fields
}

Represents a single upcoming train into the station. Next ID: 9

func (*GetUpcomingTrainsResponse_UpcomingTrain) Descriptor deprecated

func (*GetUpcomingTrainsResponse_UpcomingTrain) Descriptor() ([]byte, []int)

Deprecated: Use GetUpcomingTrainsResponse_UpcomingTrain.ProtoReflect.Descriptor instead.

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetDirection

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetHeadsign

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetLastUpdated

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetLineColors

func (x *GetUpcomingTrainsResponse_UpcomingTrain) GetLineColors() []string

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetLineName deprecated

Deprecated: Do not use.

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetProjectedArrival

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetRoute

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetRouteDisplayName

func (x *GetUpcomingTrainsResponse_UpcomingTrain) GetRouteDisplayName() string

func (*GetUpcomingTrainsResponse_UpcomingTrain) GetStatus

func (*GetUpcomingTrainsResponse_UpcomingTrain) ProtoMessage

func (*GetUpcomingTrainsResponse_UpcomingTrain) ProtoReflect

func (*GetUpcomingTrainsResponse_UpcomingTrain) Reset

func (*GetUpcomingTrainsResponse_UpcomingTrain) String

type GetUpcomingTrainsResponse_UpcomingTrain_Status

type GetUpcomingTrainsResponse_UpcomingTrain_Status int32

The possible statuses of a train.

const (
	// The status was not specified.
	GetUpcomingTrainsResponse_UpcomingTrain_STATUS_UNSPECIFIED GetUpcomingTrainsResponse_UpcomingTrain_Status = 0
	// The train is running on or close to schedule.
	GetUpcomingTrainsResponse_UpcomingTrain_ON_TIME GetUpcomingTrainsResponse_UpcomingTrain_Status = 1
	// The train is either in the station or arriving soon.
	GetUpcomingTrainsResponse_UpcomingTrain_ARRIVING_NOW GetUpcomingTrainsResponse_UpcomingTrain_Status = 2
	// The train is experiencing a delay.
	GetUpcomingTrainsResponse_UpcomingTrain_DELAYED GetUpcomingTrainsResponse_UpcomingTrain_Status = 3
)

func (GetUpcomingTrainsResponse_UpcomingTrain_Status) Descriptor

func (GetUpcomingTrainsResponse_UpcomingTrain_Status) Enum

func (GetUpcomingTrainsResponse_UpcomingTrain_Status) EnumDescriptor deprecated

Deprecated: Use GetUpcomingTrainsResponse_UpcomingTrain_Status.Descriptor instead.

func (GetUpcomingTrainsResponse_UpcomingTrain_Status) Number

func (GetUpcomingTrainsResponse_UpcomingTrain_Status) String

func (GetUpcomingTrainsResponse_UpcomingTrain_Status) Type

type ListRoutesRequest

type ListRoutesRequest struct {

	// Optional. The maximum number of elements to return for a single request.
	// If unspecified, the server will pick a reasonable default.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The page token returned by the server in a previous call. Used
	// to get the next page.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRoutesRequest) Descriptor deprecated

func (*ListRoutesRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListRoutesRequest.ProtoReflect.Descriptor instead.

func (*ListRoutesRequest) GetPageSize

func (x *ListRoutesRequest) GetPageSize() int32

func (*ListRoutesRequest) GetPageToken

func (x *ListRoutesRequest) GetPageToken() string

func (*ListRoutesRequest) ProtoMessage

func (*ListRoutesRequest) ProtoMessage()

func (*ListRoutesRequest) ProtoReflect

func (x *ListRoutesRequest) ProtoReflect() protoreflect.Message

func (*ListRoutesRequest) Reset

func (x *ListRoutesRequest) Reset()

func (*ListRoutesRequest) String

func (x *ListRoutesRequest) String() string

type ListRoutesResponse

type ListRoutesResponse struct {

	// The page of routes.
	Routes []*RouteData `protobuf:"bytes,1,rep,name=routes,proto3" json:"routes,omitempty"`
	// The page token used to request the next page. Empty/unspecified if there
	// are no more results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRoutesResponse) Descriptor deprecated

func (*ListRoutesResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListRoutesResponse.ProtoReflect.Descriptor instead.

func (*ListRoutesResponse) GetNextPageToken

func (x *ListRoutesResponse) GetNextPageToken() string

func (*ListRoutesResponse) GetRoutes

func (x *ListRoutesResponse) GetRoutes() []*RouteData

func (*ListRoutesResponse) ProtoMessage

func (*ListRoutesResponse) ProtoMessage()

func (*ListRoutesResponse) ProtoReflect

func (x *ListRoutesResponse) ProtoReflect() protoreflect.Message

func (*ListRoutesResponse) Reset

func (x *ListRoutesResponse) Reset()

func (*ListRoutesResponse) String

func (x *ListRoutesResponse) String() string

type ListStationsRequest

type ListStationsRequest struct {

	// Optional. The maximum number of elements to return for a single request.
	// If unspecified, the server will pick a reasonable default.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. The page token returned by the server in a previous call. Used
	// to get the next page.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

The request message for the list stations RPC.

func (*ListStationsRequest) Descriptor deprecated

func (*ListStationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListStationsRequest.ProtoReflect.Descriptor instead.

func (*ListStationsRequest) GetPageSize

func (x *ListStationsRequest) GetPageSize() int32

func (*ListStationsRequest) GetPageToken

func (x *ListStationsRequest) GetPageToken() string

func (*ListStationsRequest) ProtoMessage

func (*ListStationsRequest) ProtoMessage()

func (*ListStationsRequest) ProtoReflect

func (x *ListStationsRequest) ProtoReflect() protoreflect.Message

func (*ListStationsRequest) Reset

func (x *ListStationsRequest) Reset()

func (*ListStationsRequest) String

func (x *ListStationsRequest) String() string

type ListStationsResponse

type ListStationsResponse struct {

	// This page of stations.
	Stations []*StationData `protobuf:"bytes,1,rep,name=stations,proto3" json:"stations,omitempty"`
	// The page token used to request the next page. Empty/unspecified if there
	// are no more results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

The response message for the list stations RPC.

func (*ListStationsResponse) Descriptor deprecated

func (*ListStationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListStationsResponse.ProtoReflect.Descriptor instead.

func (*ListStationsResponse) GetNextPageToken

func (x *ListStationsResponse) GetNextPageToken() string

func (*ListStationsResponse) GetStations

func (x *ListStationsResponse) GetStations() []*StationData

func (*ListStationsResponse) ProtoMessage

func (*ListStationsResponse) ProtoMessage()

func (*ListStationsResponse) ProtoReflect

func (x *ListStationsResponse) ProtoReflect() protoreflect.Message

func (*ListStationsResponse) Reset

func (x *ListStationsResponse) Reset()

func (*ListStationsResponse) String

func (x *ListStationsResponse) String() string

type Route

type Route int32

Full list of all routes within the system.

const (
	Route_ROUTE_UNSPECIFIED Route = 0
	// Journal Square to 33rd Street via Hoboken
	Route_JSQ_33_HOB Route = 1
	// Deprecated: Do not use.
	Route_jsq_33_hob Route = 1
	// Hoboken to 33rd Street
	Route_HOB_33 Route = 2
	// Deprecated: Do not use.
	Route_hob_33 Route = 2
	// Hoboken to World Trade Center
	Route_HOB_WTC Route = 3
	// Deprecated: Do not use.
	Route_hob_wtc Route = 3
	// Journal Square to 33rd Street
	Route_JSQ_33 Route = 4
	// Deprecated: Do not use.
	Route_jsq_33 Route = 4
	// Newark to World Trade Center
	Route_NWK_WTC Route = 5
	// Deprecated: Do not use.
	Route_nwk_wtc Route = 5
	// Newport to Hoboken Shuttle Train
	Route_NPT_HOB Route = 6
	// Deprecated: Do not use.
	Route_npt_hob Route = 6
)

func (Route) Descriptor

func (Route) Descriptor() protoreflect.EnumDescriptor

func (Route) Enum

func (x Route) Enum() *Route

func (Route) EnumDescriptor deprecated

func (Route) EnumDescriptor() ([]byte, []int)

Deprecated: Use Route.Descriptor instead.

func (Route) Number

func (x Route) Number() protoreflect.EnumNumber

func (Route) String

func (x Route) String() string

func (Route) Type

func (Route) Type() protoreflect.EnumType

type RouteData

type RouteData struct {

	// The route this entry represents.
	Route Route `protobuf:"varint,1,opt,name=route,proto3,enum=path_api.v1.Route" json:"route,omitempty"`
	// The ID in the GTFS database of this route.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The name (long name) of the route.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// The color (headsign color) of this route.
	Color string `protobuf:"bytes,4,opt,name=color,proto3" json:"color,omitempty"`
	// The collection of lines along this route.
	Lines []*RouteData_RouteLine `protobuf:"bytes,5,rep,name=lines,proto3" json:"lines,omitempty"`
	// contains filtered or unexported fields
}

Data representing a single route in the PATH system.

func (*RouteData) Descriptor deprecated

func (*RouteData) Descriptor() ([]byte, []int)

Deprecated: Use RouteData.ProtoReflect.Descriptor instead.

func (*RouteData) GetColor

func (x *RouteData) GetColor() string

func (*RouteData) GetId

func (x *RouteData) GetId() string

func (*RouteData) GetLines

func (x *RouteData) GetLines() []*RouteData_RouteLine

func (*RouteData) GetName

func (x *RouteData) GetName() string

func (*RouteData) GetRoute

func (x *RouteData) GetRoute() Route

func (*RouteData) ProtoMessage

func (*RouteData) ProtoMessage()

func (*RouteData) ProtoReflect

func (x *RouteData) ProtoReflect() protoreflect.Message

func (*RouteData) Reset

func (x *RouteData) Reset()

func (*RouteData) String

func (x *RouteData) String() string

type RouteData_RouteLine

type RouteData_RouteLine struct {

	// The friendly name of this route line.
	DisplayName string `protobuf:"bytes,1,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// The headsign displayed when a train is traveling along this line.
	Headsign string `protobuf:"bytes,2,opt,name=headsign,proto3" json:"headsign,omitempty"`
	// The direction of travel.
	Direction Direction `protobuf:"varint,3,opt,name=direction,proto3,enum=path_api.v1.Direction" json:"direction,omitempty"`
	// contains filtered or unexported fields
}

Represents a single line within this route (think direction of travel).

func (*RouteData_RouteLine) Descriptor deprecated

func (*RouteData_RouteLine) Descriptor() ([]byte, []int)

Deprecated: Use RouteData_RouteLine.ProtoReflect.Descriptor instead.

func (*RouteData_RouteLine) GetDirection

func (x *RouteData_RouteLine) GetDirection() Direction

func (*RouteData_RouteLine) GetDisplayName

func (x *RouteData_RouteLine) GetDisplayName() string

func (*RouteData_RouteLine) GetHeadsign

func (x *RouteData_RouteLine) GetHeadsign() string

func (*RouteData_RouteLine) ProtoMessage

func (*RouteData_RouteLine) ProtoMessage()

func (*RouteData_RouteLine) ProtoReflect

func (x *RouteData_RouteLine) ProtoReflect() protoreflect.Message

func (*RouteData_RouteLine) Reset

func (x *RouteData_RouteLine) Reset()

func (*RouteData_RouteLine) String

func (x *RouteData_RouteLine) String() string

type RoutesClient

type RoutesClient interface {
	// Lists all routes within the PATH system.
	ListRoutes(ctx context.Context, in *ListRoutesRequest, opts ...grpc.CallOption) (*ListRoutesResponse, error)
	// Gets information about a single route.
	GetRoute(ctx context.Context, in *GetRouteRequest, opts ...grpc.CallOption) (*RouteData, error)
	// Gets the posted train schedule for a route.
	GetRouteSchedule(ctx context.Context, in *GetRouteScheduleRequest, opts ...grpc.CallOption) (*GetRouteScheduleResponse, error)
}

RoutesClient is the client API for Routes service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewRoutesClient

func NewRoutesClient(cc grpc.ClientConnInterface) RoutesClient

type RoutesServer

type RoutesServer interface {
	// Lists all routes within the PATH system.
	ListRoutes(context.Context, *ListRoutesRequest) (*ListRoutesResponse, error)
	// Gets information about a single route.
	GetRoute(context.Context, *GetRouteRequest) (*RouteData, error)
	// Gets the posted train schedule for a route.
	GetRouteSchedule(context.Context, *GetRouteScheduleRequest) (*GetRouteScheduleResponse, error)
}

RoutesServer is the server API for Routes service. All implementations should embed UnimplementedRoutesServer for forward compatibility

type ServerClient

type ServerClient interface {
	// Liveness/readiness probe, used by ESP to ensure the backend is up and ready.
	GetHealth(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

ServerClient is the client API for Server service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewServerClient

func NewServerClient(cc grpc.ClientConnInterface) ServerClient

type ServerServer

type ServerServer interface {
	// Liveness/readiness probe, used by ESP to ensure the backend is up and ready.
	GetHealth(context.Context, *emptypb.Empty) (*emptypb.Empty, error)
}

ServerServer is the server API for Server service. All implementations should embed UnimplementedServerServer for forward compatibility

type Station

type Station int32

Full list of all PATH stations in the system.

const (
	Station_STATION_UNSPECIFIED Station = 0
	Station_NEWARK              Station = 1
	// Deprecated: Do not use.
	Station_newark   Station = 1
	Station_HARRISON Station = 2
	// Deprecated: Do not use.
	Station_harrison       Station = 2
	Station_JOURNAL_SQUARE Station = 3
	// Deprecated: Do not use.
	Station_journal_square Station = 3
	Station_GROVE_STREET   Station = 4
	// Deprecated: Do not use.
	Station_grove_street   Station = 4
	Station_EXCHANGE_PLACE Station = 5
	// Deprecated: Do not use.
	Station_exchange_place     Station = 5
	Station_WORLD_TRADE_CENTER Station = 6
	// Deprecated: Do not use.
	Station_world_trade_center Station = 6
	Station_NEWPORT            Station = 7
	// Deprecated: Do not use.
	Station_newport Station = 7
	Station_HOBOKEN Station = 8
	// Deprecated: Do not use.
	Station_hoboken            Station = 8
	Station_CHRISTOPHER_STREET Station = 9
	// Deprecated: Do not use.
	Station_christopher_street Station = 9
	Station_NINTH_STREET       Station = 10
	// Deprecated: Do not use.
	Station_ninth_street      Station = 10
	Station_FOURTEENTH_STREET Station = 11
	// Deprecated: Do not use.
	Station_fourteenth_street   Station = 11
	Station_TWENTY_THIRD_STREET Station = 12
	// Deprecated: Do not use.
	Station_twenty_third_street Station = 12
	Station_THIRTY_THIRD_STREET Station = 13
	// Deprecated: Do not use.
	Station_thirty_third_street Station = 13
)

func (Station) Descriptor

func (Station) Descriptor() protoreflect.EnumDescriptor

func (Station) Enum

func (x Station) Enum() *Station

func (Station) EnumDescriptor deprecated

func (Station) EnumDescriptor() ([]byte, []int)

Deprecated: Use Station.Descriptor instead.

func (Station) Number

func (x Station) Number() protoreflect.EnumNumber

func (Station) String

func (x Station) String() string

func (Station) Type

func (Station) Type() protoreflect.EnumType

type StationData

type StationData struct {

	// The PATH station in question.
	Station Station `protobuf:"varint,1,opt,name=station,proto3,enum=path_api.v1.Station" json:"station,omitempty"`
	// The ID (stop_id) of this station.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The human-friendly name of this station.
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// The geographic coordinates (lat/lon) of this station.
	Coordinates *latlng.LatLng `protobuf:"bytes,4,opt,name=coordinates,proto3" json:"coordinates,omitempty"`
	// Collection of platforms/tracks within the station.
	Platforms []*StationData_Area `protobuf:"bytes,6,rep,name=platforms,proto3" json:"platforms,omitempty"`
	// Collection of entrances to the station.
	Entrances []*StationData_Area `protobuf:"bytes,7,rep,name=entrances,proto3" json:"entrances,omitempty"`
	// The timezone in which this station is located.
	Timezone string `protobuf:"bytes,8,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// contains filtered or unexported fields
}

Represents a station within the PATH system. Loosely follows GTFS format for "stops" representing location_type of 1. This doesn't directly follow GTFS because the format is both unwieldy for JSON/HTTP APIs and the PATH GTFS data does not populate most fields.

func (*StationData) Descriptor deprecated

func (*StationData) Descriptor() ([]byte, []int)

Deprecated: Use StationData.ProtoReflect.Descriptor instead.

func (*StationData) GetCoordinates

func (x *StationData) GetCoordinates() *latlng.LatLng

func (*StationData) GetEntrances

func (x *StationData) GetEntrances() []*StationData_Area

func (*StationData) GetId

func (x *StationData) GetId() string

func (*StationData) GetName

func (x *StationData) GetName() string

func (*StationData) GetPlatforms

func (x *StationData) GetPlatforms() []*StationData_Area

func (*StationData) GetStation

func (x *StationData) GetStation() Station

func (*StationData) GetTimezone

func (x *StationData) GetTimezone() string

func (*StationData) ProtoMessage

func (*StationData) ProtoMessage()

func (*StationData) ProtoReflect

func (x *StationData) ProtoReflect() protoreflect.Message

func (*StationData) Reset

func (x *StationData) Reset()

func (*StationData) String

func (x *StationData) String() string

type StationData_Area

type StationData_Area struct {

	// The ID (stop_id) of this platform.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The human-friendly name of this platform.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The grographic coordinates (lat/lon) of this station.
	Coordinates *latlng.LatLng `protobuf:"bytes,3,opt,name=coordinates,proto3" json:"coordinates,omitempty"`
	// contains filtered or unexported fields
}

Represents a platform/track/entrence area within a station. Representing GTFS stops with location_type of 0 and a parent_station.

func (*StationData_Area) Descriptor deprecated

func (*StationData_Area) Descriptor() ([]byte, []int)

Deprecated: Use StationData_Area.ProtoReflect.Descriptor instead.

func (*StationData_Area) GetCoordinates

func (x *StationData_Area) GetCoordinates() *latlng.LatLng

func (*StationData_Area) GetId

func (x *StationData_Area) GetId() string

func (*StationData_Area) GetName

func (x *StationData_Area) GetName() string

func (*StationData_Area) ProtoMessage

func (*StationData_Area) ProtoMessage()

func (*StationData_Area) ProtoReflect

func (x *StationData_Area) ProtoReflect() protoreflect.Message

func (*StationData_Area) Reset

func (x *StationData_Area) Reset()

func (*StationData_Area) String

func (x *StationData_Area) String() string

type StationsClient

type StationsClient interface {
	// Lists the metadata for all available stations.
	ListStations(ctx context.Context, in *ListStationsRequest, opts ...grpc.CallOption) (*ListStationsResponse, error)
	// Gets the metadata for a specific station.
	GetStation(ctx context.Context, in *GetStationRequest, opts ...grpc.CallOption) (*StationData, error)
	// Gets the posted train schedule for a station.
	GetStationSchedule(ctx context.Context, in *GetStationScheduleRequest, opts ...grpc.CallOption) (*GetStationScheduleResponse, error)
	// Gets the expected upcoming trains for the station using realtime data.
	GetUpcomingTrains(ctx context.Context, in *GetUpcomingTrainsRequest, opts ...grpc.CallOption) (*GetUpcomingTrainsResponse, error)
}

StationsClient is the client API for Stations service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewStationsClient

func NewStationsClient(cc grpc.ClientConnInterface) StationsClient

type StationsServer

type StationsServer interface {
	// Lists the metadata for all available stations.
	ListStations(context.Context, *ListStationsRequest) (*ListStationsResponse, error)
	// Gets the metadata for a specific station.
	GetStation(context.Context, *GetStationRequest) (*StationData, error)
	// Gets the posted train schedule for a station.
	GetStationSchedule(context.Context, *GetStationScheduleRequest) (*GetStationScheduleResponse, error)
	// Gets the expected upcoming trains for the station using realtime data.
	GetUpcomingTrains(context.Context, *GetUpcomingTrainsRequest) (*GetUpcomingTrainsResponse, error)
}

StationsServer is the server API for Stations service. All implementations should embed UnimplementedStationsServer for forward compatibility

type UnimplementedRoutesServer

type UnimplementedRoutesServer struct {
}

UnimplementedRoutesServer should be embedded to have forward compatible implementations.

func (UnimplementedRoutesServer) GetRoute

func (UnimplementedRoutesServer) GetRouteSchedule

func (UnimplementedRoutesServer) ListRoutes

type UnimplementedServerServer

type UnimplementedServerServer struct {
}

UnimplementedServerServer should be embedded to have forward compatible implementations.

func (UnimplementedServerServer) GetHealth

type UnimplementedStationsServer

type UnimplementedStationsServer struct {
}

UnimplementedStationsServer should be embedded to have forward compatible implementations.

func (UnimplementedStationsServer) GetStation

func (UnimplementedStationsServer) GetUpcomingTrains

func (UnimplementedStationsServer) ListStations

type UnsafeRoutesServer

type UnsafeRoutesServer interface {
	// contains filtered or unexported methods
}

UnsafeRoutesServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RoutesServer will result in compilation errors.

type UnsafeServerServer

type UnsafeServerServer interface {
	// contains filtered or unexported methods
}

UnsafeServerServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServerServer will result in compilation errors.

type UnsafeStationsServer

type UnsafeStationsServer interface {
	// contains filtered or unexported methods
}

UnsafeStationsServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to StationsServer will result in compilation errors.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL