Module: Google::Maps::FleetEngine

Defined in:
lib/google/maps/fleet_engine.rb,
lib/google/maps/fleet_engine/version.rb

Constant Summary collapse

VERSION = 
"1.1.2"

Class Method Summary collapse

Class Method Details

.trip_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TripService.

By default, this returns an instance of Google::Maps::FleetEngine::V1::TripService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the TripService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TripService service. You can determine whether the method will succeed by calling trip_service_available?.

About TripService

Trip management service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/google/maps/fleet_engine.rb', line 57

def self.trip_service version: :v1, transport: :grpc, &block
  require "google/maps/fleet_engine/#{version.to_s.downcase}"

  package_name = Google::Maps::FleetEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Maps::FleetEngine.const_get(package_name).const_get(:TripService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.trip_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the TripService service is supported by the current client. If true, you can retrieve a client object by calling trip_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TripService service, or if the versioned client gem needs an update to support the TripService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/google/maps/fleet_engine.rb', line 81

def self.trip_service_available? version: :v1, transport: :grpc
  require "google/maps/fleet_engine/#{version.to_s.downcase}"
  package_name = Google::Maps::FleetEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Maps::FleetEngine.const_get package_name
  return false unless service_module.const_defined? :TripService
  service_module = service_module.const_get :TripService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.vehicle_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for VehicleService.

By default, this returns an instance of Google::Maps::FleetEngine::V1::VehicleService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the VehicleService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the VehicleService service. You can determine whether the method will succeed by calling vehicle_service_available?.

About VehicleService

Vehicle management service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/maps/fleet_engine.rb', line 127

def self.vehicle_service version: :v1, transport: :grpc, &block
  require "google/maps/fleet_engine/#{version.to_s.downcase}"

  package_name = Google::Maps::FleetEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Maps::FleetEngine.const_get(package_name).const_get(:VehicleService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.vehicle_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the VehicleService service is supported by the current client. If true, you can retrieve a client object by calling vehicle_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the VehicleService service, or if the versioned client gem needs an update to support the VehicleService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/google/maps/fleet_engine.rb', line 151

def self.vehicle_service_available? version: :v1, transport: :grpc
  require "google/maps/fleet_engine/#{version.to_s.downcase}"
  package_name = Google::Maps::FleetEngine
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Maps::FleetEngine.const_get package_name
  return false unless service_module.const_defined? :VehicleService
  service_module = service_module.const_get :VehicleService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end