Class: Google::Maps::FleetEngine::V1::TripService::Client
- Inherits:
-
Object
- Object
- Google::Maps::FleetEngine::V1::TripService::Client
- Includes:
- Paths
- Defined in:
- lib/google/maps/fleet_engine/v1/trip_service/client.rb
Overview
Client for the TripService service.
Trip management service.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the TripService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the TripService Client instance.
-
#create_trip(request, options = nil) {|response, operation| ... } ⇒ ::Google::Maps::FleetEngine::V1::Trip
Creates a trip in the Fleet Engine and returns the new trip.
-
#get_trip(request, options = nil) {|response, operation| ... } ⇒ ::Google::Maps::FleetEngine::V1::Trip
Get information about a single trip.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new TripService client object.
-
#report_billable_trip(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Report billable trip usage.
-
#search_trips(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::V1::Trip>
Get all the trips for a specific vehicle.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_trip(request, options = nil) {|response, operation| ... } ⇒ ::Google::Maps::FleetEngine::V1::Trip
Updates trip data.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new TripService client object.
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 144 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/maps/fleetengine/v1/trip_api_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @trip_service_stub = ::Gapic::ServiceStub.new( ::Google::Maps::FleetEngine::V1::TripService::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the TripService Client class.
See Configuration for a description of the configuration fields.
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 62 def self.configure @configure ||= begin namespace = ["Google", "Maps", "FleetEngine", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.create_trip.timeout = 15.0 default_config.rpcs.create_trip.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_trip.timeout = 15.0 default_config.rpcs.get_trip.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.search_trips.timeout = 15.0 default_config.rpcs.search_trips.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.update_trip.timeout = 15.0 default_config.rpcs.update_trip.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the TripService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
114 115 116 117 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 114 def configure yield @config if block_given? @config end |
#create_trip(request, options = nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip #create_trip(header: nil, parent: nil, trip_id: nil, trip: nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip
Creates a trip in the Fleet Engine and returns the new trip.
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 281 def create_trip request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::V1::CreateTripRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_trip..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Maps::FleetEngine::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent && %r{^providers/[^/]+/?$}.match?(request.parent) header_params["provider_id"] = request.parent end request_params_header = URI.encode_www_form header_params [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_trip.timeout, metadata: , retry_policy: @config.rpcs.create_trip.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trip_service_stub.call_rpc :create_trip, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_trip(request, options = nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip #get_trip(header: nil, name: nil, view: nil, current_route_segment_version: nil, remaining_waypoints_version: nil, route_format_type: nil, current_route_segment_traffic_version: nil, remaining_waypoints_route_version: nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip
Get information about a single trip.
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 403 def get_trip request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::V1::GetTripRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_trip..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Maps::FleetEngine::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name && %r{^providers/[^/]+/?$}.match?(request.name) header_params["provider_id"] = request.name end request_params_header = URI.encode_www_form header_params [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_trip.timeout, metadata: , retry_policy: @config.rpcs.get_trip.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trip_service_stub.call_rpc :get_trip, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#report_billable_trip(request, options = nil) ⇒ ::Google::Protobuf::Empty #report_billable_trip(name: nil, country_code: nil, platform: nil, related_ids: nil, solution_type: nil) ⇒ ::Google::Protobuf::Empty
Report billable trip usage.
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 507 def report_billable_trip request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::V1::ReportBillableTripRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.report_billable_trip..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Maps::FleetEngine::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name && %r{^providers/[^/]+/?$}.match?(request.name) header_params["provider_id"] = request.name end request_params_header = URI.encode_www_form header_params [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.report_billable_trip.timeout, metadata: , retry_policy: @config.rpcs.report_billable_trip.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trip_service_stub.call_rpc :report_billable_trip, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#search_trips(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::V1::Trip> #search_trips(header: nil, parent: nil, vehicle_id: nil, active_trips_only: nil, page_size: nil, page_token: nil, minimum_staleness: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::V1::Trip>
Get all the trips for a specific vehicle.
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 622 def search_trips request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::V1::SearchTripsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.search_trips..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Maps::FleetEngine::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent && %r{^providers/[^/]+/?$}.match?(request.parent) header_params["provider_id"] = request.parent end request_params_header = URI.encode_www_form header_params [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.search_trips.timeout, metadata: , retry_policy: @config.rpcs.search_trips.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trip_service_stub.call_rpc :search_trips, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @trip_service_stub, :search_trips, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
124 125 126 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 124 def universe_domain @trip_service_stub.universe_domain end |
#update_trip(request, options = nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip #update_trip(header: nil, name: nil, trip: nil, update_mask: nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip
Updates trip data.
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 |
# File 'lib/google/maps/fleet_engine/v1/trip_service/client.rb', line 760 def update_trip request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::V1::UpdateTripRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_trip..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Maps::FleetEngine::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name && %r{^providers/[^/]+/?$}.match?(request.name) header_params["provider_id"] = request.name end request_params_header = URI.encode_www_form header_params [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_trip.timeout, metadata: , retry_policy: @config.rpcs.update_trip.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @trip_service_stub.call_rpc :update_trip, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |