Class: Google::Maps::FleetEngine::V1::TripService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb

Overview

REST client for the TripService service.

Trip management service.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#trip_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new TripService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Maps::FleetEngine::V1::TripService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Maps::FleetEngine::V1::TripService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the TripService client.

Yield Parameters:



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
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 146

def initialize
  # 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 = ::Google::Maps::FleetEngine::V1::TripService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the TripService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all TripService clients
::Google::Maps::FleetEngine::V1::TripService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
98
99
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 64

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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



116
117
118
119
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 116

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.

Examples:

Basic example

require "google/maps/fleet_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Maps::FleetEngine::V1::TripService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Maps::FleetEngine::V1::CreateTripRequest.new

# Call the create_trip method.
result = client.create_trip request

# The returned object is of type Google::Maps::FleetEngine::V1::Trip.
p result

Overloads:

  • #create_trip(request, options = nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip

    Pass arguments to create_trip via a request object, either of type CreateTripRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::V1::CreateTripRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_trip(header: nil, parent: nil, trip_id: nil, trip: nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip

    Pass arguments to create_trip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • header (::Google::Maps::FleetEngine::V1::RequestHeader, ::Hash) (defaults to: nil) —

      The standard Fleet Engine request header.

    • parent (::String) (defaults to: nil) —

      Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

    • trip_id (::String) (defaults to: nil) —

      Required. Unique Trip ID. Subject to the following restrictions:

      • Must be a valid Unicode string.
      • Limited to a maximum length of 64 characters.
      • Normalized according to Unicode Normalization Form C.
      • May not contain any of the following ASCII characters: '/', ':', '?', ',', or '#'.
    • trip (::Google::Maps::FleetEngine::V1::Trip, ::Hash) (defaults to: nil) —

      Required. Trip entity to create.

      When creating a Trip, the following fields are required:

      • trip_type
      • pickup_point

      The following fields are used if you provide them:

      • number_of_passengers
      • vehicle_id
      • dropoff_point
      • intermediate_destinations
      • vehicle_waypoints

      All other Trip fields are ignored. For example, all trips start with a trip_status of NEW even if you pass in a trip_status of CANCELED in the creation request.

      Only EXCLUSIVE trips support intermediate_destinations.

      When vehicle_id is set for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints for the vehicle, otherwise the waypoint order will be undetermined.

      When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips.

      The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



273
274
275
276
277
278
279
280
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
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 273

def create_trip request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_trip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_trip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_trip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @trip_service_stub.create_trip request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/maps/fleet_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Maps::FleetEngine::V1::TripService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Maps::FleetEngine::V1::GetTripRequest.new

# Call the get_trip method.
result = client.get_trip request

# The returned object is of type Google::Maps::FleetEngine::V1::Trip.
p result

Overloads:

  • #get_trip(request, options = nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip

    Pass arguments to get_trip via a request object, either of type GetTripRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::V1::GetTripRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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

    Pass arguments to get_trip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • header (::Google::Maps::FleetEngine::V1::RequestHeader, ::Hash) (defaults to: nil) —

      The standard Fleet Engine request header.

    • name (::String) (defaults to: nil) —

      Required. Must be in the format providers/{provider}/trips/{trip}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

    • view (::Google::Maps::FleetEngine::V1::TripView) (defaults to: nil) —

      The subset of Trip fields that should be returned and their interpretation.

    • current_route_segment_version (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Indicates the minimum timestamp (exclusive) for which Trip.route or Trip.current_route_segment data are retrieved. If route data are unchanged since this timestamp, the route field is not set in the response. If a minimum is unspecified, the route data are always retrieved.

    • remaining_waypoints_version (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints are retrieved. If they are unchanged since this timestamp, the remaining_waypoints are not set in the response. If this field is unspecified, remaining_waypoints is always retrieved.

    • route_format_type (::Google::Maps::FleetEngine::V1::PolylineFormatType) (defaults to: nil) —

      The returned current route format, LAT_LNG_LIST_TYPE (in Trip.route), or ENCODED_POLYLINE_TYPE (in Trip.current_route_segment). The default is LAT_LNG_LIST_TYPE.

    • current_route_segment_traffic_version (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Indicates the minimum timestamp (exclusive) for which Trip.current_route_segment_traffic is retrieved. If traffic data are unchanged since this timestamp, the current_route_segment_traffic field is not set in the response. If a minimum is unspecified, the traffic data are always retrieved. Note that traffic is only available for On-Demand Rides and Deliveries Solution customers.

    • remaining_waypoints_route_version (::Google::Protobuf::Timestamp, ::Hash) (defaults to: nil) —

      Indicates the minimum timestamp (exclusive) for which Trip.remaining_waypoints.traffic_to_waypoint and Trip.remaining_waypoints.path_to_waypoint data are retrieved. If data are unchanged since this timestamp, the fields above are not set in the response. If remaining_waypoints_route_version is unspecified, traffic and path are always retrieved.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 387

def get_trip request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_trip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_trip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_trip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @trip_service_stub.get_trip request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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.

Examples:

Basic example

require "google/maps/fleet_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Maps::FleetEngine::V1::TripService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Maps::FleetEngine::V1::ReportBillableTripRequest.new

# Call the report_billable_trip method.
result = client.report_billable_trip request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #report_billable_trip(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to report_billable_trip via a request object, either of type ReportBillableTripRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::V1::ReportBillableTripRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #report_billable_trip(name: nil, country_code: nil, platform: nil, related_ids: nil, solution_type: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to report_billable_trip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Must be in the format providers/{provider}/billableTrips/{billable_trip}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

    • country_code (::String) (defaults to: nil) —

      Required. Two letter country code of the country where the trip takes place. Price is defined according to country code.

    • platform (::Google::Maps::FleetEngine::V1::BillingPlatformIdentifier) (defaults to: nil) —

      The platform upon which the request was issued.

    • related_ids (::Array<::String>) (defaults to: nil) —

      The identifiers that are directly related to the trip being reported. These are usually IDs (for example, session IDs) of pre-booking operations done before the trip ID is available. The number of related_ids is limited to 50.

    • solution_type (::Google::Maps::FleetEngine::V1::ReportBillableTripRequest::SolutionType) (defaults to: nil) —

      The type of GMP product solution (for example, ON_DEMAND_RIDESHARING_AND_DELIVERIES) used for the reported trip.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 483

def report_billable_trip request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.report_billable_trip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.report_billable_trip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.report_billable_trip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @trip_service_stub.report_billable_trip request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#search_trips(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::PagedEnumerable<::Google::Maps::FleetEngine::V1::Trip>

Get all the trips for a specific vehicle.

Examples:

Basic example

require "google/maps/fleet_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Maps::FleetEngine::V1::TripService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Maps::FleetEngine::V1::SearchTripsRequest.new

# Call the search_trips method.
result = client.search_trips request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Maps::FleetEngine::V1::Trip.
  p item
end

Overloads:

  • #search_trips(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Maps::FleetEngine::V1::Trip>

    Pass arguments to search_trips via a request object, either of type SearchTripsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::V1::SearchTripsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #search_trips(header: nil, parent: nil, vehicle_id: nil, active_trips_only: nil, page_size: nil, page_token: nil, minimum_staleness: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Maps::FleetEngine::V1::Trip>

    Pass arguments to search_trips via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • header (::Google::Maps::FleetEngine::V1::RequestHeader, ::Hash) (defaults to: nil) —

      The standard Fleet Engine request header.

    • parent (::String) (defaults to: nil) —

      Required. Must be in the format providers/{provider}. The provider must be the Project ID (for example, sample-cloud-project) of the Google Cloud Project of which the service account making this call is a member.

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

      The vehicle associated with the trips in the request. If unspecified, the returned trips do not contain:

      • current_route_segment
      • remaining_waypoints
      • remaining_distance_meters
      • eta_to_first_waypoint
    • active_trips_only (::Boolean) (defaults to: nil) —

      If set to true, the response includes Trips that influence a driver's route.

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

      If not set, the server decides the number of results to return.

    • page_token (::String) (defaults to: nil) —

      Set this to a value previously returned in the SearchTripsResponse to continue from previous results.

    • minimum_staleness (::Google::Protobuf::Duration, ::Hash) (defaults to: nil) —

      If specified, returns the trips that have not been updated after the time (current - minimum_staleness).

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 590

def search_trips request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.search_trips.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.search_trips.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search_trips.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @trip_service_stub.search_trips request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @trip_service_stub, :search_trips, "trips", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 126

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.

Examples:

Basic example

require "google/maps/fleet_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Maps::FleetEngine::V1::TripService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Maps::FleetEngine::V1::UpdateTripRequest.new

# Call the update_trip method.
result = client.update_trip request

# The returned object is of type Google::Maps::FleetEngine::V1::Trip.
p result

Overloads:

  • #update_trip(request, options = nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip

    Pass arguments to update_trip via a request object, either of type UpdateTripRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::V1::UpdateTripRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_trip(header: nil, name: nil, trip: nil, update_mask: nil) ⇒ ::Google::Maps::FleetEngine::V1::Trip

    Pass arguments to update_trip via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • header (::Google::Maps::FleetEngine::V1::RequestHeader, ::Hash) (defaults to: nil) —

      The standard Fleet Engine request header.

    • name (::String) (defaults to: nil) —

      Required. Must be in the format providers/{provider}/trips/{trip}. The provider must be the Project ID (for example, sample-consumer-project) of the Google Cloud Project of which the service account making this call is a member.

    • trip (::Google::Maps::FleetEngine::V1::Trip, ::Hash) (defaults to: nil) —

      Required. The Trip associated with the update.

      The following fields are maintained by the Fleet Engine. Do not update them using Trip.update.

      • current_route_segment
      • current_route_segment_end_point
      • current_route_segment_traffic
      • current_route_segment_traffic_version
      • current_route_segment_version
      • dropoff_time
      • eta_to_next_waypoint
      • intermediate_destinations_version
      • last_location
      • name
      • number_of_passengers
      • pickup_time
      • remaining_distance_meters
      • remaining_time_to_first_waypoint
      • remaining_waypoints
      • remaining_waypoints_version
      • route

      When you update the Trip.vehicle_id for a shared trip, you must supply the list of Trip.vehicle_waypoints to specify the order of the remaining waypoints, otherwise the order will be undetermined.

      When you specify Trip.vehicle_waypoints, the list must contain all the remaining waypoints of the vehicle's trips, with no extra waypoints. You must order these waypoints such that for a given trip, the pickup point is before intermediate destinations, and all intermediate destinations come before the drop-off point. An EXCLUSIVE trip's waypoints must not interleave with any other trips. The trip_id, waypoint_type and location fields are used, and all other TripWaypoint fields in vehicle_waypoints are ignored.

      To avoid a race condition for trips with multiple destinations, you should provide Trip.intermediate_destinations_version when updating the trip status to ENROUTE_TO_INTERMEDIATE_DESTINATION. The Trip.intermediate_destinations_version passed must be consistent with Fleet Engine's version. If it isn't, the request fails.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. The field mask indicating which fields in Trip to update. The update_mask must contain at least one field.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb', line 720

def update_trip request, options = 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
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_trip.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_trip.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_trip.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @trip_service_stub.update_trip request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end