Class: OnebusawaySDK::Models::TripForVehicleRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(vehicle_id:, include_schedule: nil, include_status: nil, include_trip: nil, time: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OnebusawaySDK::Models::TripForVehicleRetrieveParams for more details.

Parameters:

  • vehicle_id (String)
  • include_schedule (Boolean) (defaults to: nil) —

    Determines whether full <schedule/> element is included in the <tripDetails/> se

  • include_status (Boolean) (defaults to: nil) —

    Determines whether the full <status/> element is included in the <tripDetails/>

  • include_trip (Boolean) (defaults to: nil) —

    Determines whether full <trip/> element is included in the <references/> section

  • time (Integer) (defaults to: nil) —

    Time parameter to query the system at a specific time (optional).

  • request_options (OnebusawaySDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb', line 42

Instance Attribute Details

#include_schedule ⇒ Boolean?

Determines whether full <schedule/> element is included in the <tripDetails/> section. Defaults to false.

Returns:

  • (Boolean, nil) 


20
 
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb', line 20

optional :include_schedule, OnebusawaySDK::Internal::Type::Boolean

#include_status ⇒ Boolean?

Determines whether the full <status/> element is included in the <tripDetails/> section. Defaults to true.

Returns:

  • (Boolean, nil) 


27
 
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb', line 27

optional :include_status, OnebusawaySDK::Internal::Type::Boolean

#include_trip ⇒ Boolean?

Determines whether full <trip/> element is included in the <references/> section. Defaults to false.

Returns:

  • (Boolean, nil) 


34
 
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb', line 34

optional :include_trip, OnebusawaySDK::Internal::Type::Boolean

#time ⇒ Integer?

Time parameter to query the system at a specific time (optional).

Returns:

  • (Integer, nil) 


40
 
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb', line 40

optional :time, Integer

#vehicle_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/onebusaway_sdk/models/trip_for_vehicle_retrieve_params.rb', line 13

required :vehicle_id, String