Class: Google::Maps::FleetEngine::Delivery::V1::DeliveryService::Client

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

Overview

Client for the DeliveryService service.

The Last Mile Delivery service.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#delivery_vehicle_path, #provider_path, #task_path, #task_tracking_info_path

Constructor Details

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

Create a new DeliveryService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the DeliveryService client.

Yield Parameters:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 175

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/delivery/v1/delivery_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

  @delivery_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Maps::FleetEngine::Delivery::V1::DeliveryService::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,
    logger: @config.logger
  )

  @delivery_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

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

Configure the DeliveryService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Maps", "FleetEngine", "Delivery", "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_delivery_vehicle.timeout = 60.0
    default_config.rpcs.create_delivery_vehicle.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_delivery_vehicle.timeout = 60.0
    default_config.rpcs.get_delivery_vehicle.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_delivery_vehicle.timeout = 60.0
    default_config.rpcs.update_delivery_vehicle.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.batch_create_tasks.timeout = 60.0
    default_config.rpcs.batch_create_tasks.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_task.timeout = 60.0
    default_config.rpcs.create_task.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_task.timeout = 60.0
    default_config.rpcs.get_task.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_task.timeout = 60.0
    default_config.rpcs.update_task.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_tasks.timeout = 60.0
    default_config.rpcs.list_tasks.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_task_tracking_info.timeout = 60.0
    default_config.rpcs.get_task_tracking_info.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_delivery_vehicles.timeout = 60.0
    default_config.rpcs.list_delivery_vehicles.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

#batch_create_tasks(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::BatchCreateTasksResponse #batch_create_tasks(header: nil, parent: nil, requests: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::BatchCreateTasksResponse

Creates and returns a batch of new Task objects.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #batch_create_tasks(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::BatchCreateTasksResponse

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::BatchCreateTasksRequest, ::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.

  • #batch_create_tasks(header: nil, parent: nil, requests: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::BatchCreateTasksResponse

    Pass arguments to batch_create_tasks 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header. Note: If you set this field, then the header field in the CreateTaskRequest messages must either be empty, or it must match this field.

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

      Required. The parent resource shared by all tasks. This value must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project. The parent field in the CreateTaskRequest messages must either be empty, or it must match this field.

    • requests (::Array<::Google::Maps::FleetEngine::Delivery::V1::CreateTaskRequest, ::Hash>) (defaults to: nil) —

      Required. The request message that specifies the resources to create. Note: You can create a maximum of 500 tasks in a batch.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 688

def batch_create_tasks request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::BatchCreateTasksRequest

  # 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
  metadata = @config.rpcs.batch_create_tasks.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :batch_create_tasks, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

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

Configure the DeliveryService 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:



145
146
147
148
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 145

def configure
  yield @config if block_given?
  @config
end

#create_delivery_vehicle(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle #create_delivery_vehicle(header: nil, parent: nil, delivery_vehicle_id: nil, delivery_vehicle: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

Creates and returns a new DeliveryVehicle.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #create_delivery_vehicle(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::CreateDeliveryVehicleRequest, ::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_delivery_vehicle(header: nil, parent: nil, delivery_vehicle_id: nil, delivery_vehicle: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

    Pass arguments to create_delivery_vehicle 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

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

      Required. The Delivery Vehicle ID must be unique and 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 '#'.
    • delivery_vehicle (::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle, ::Hash) (defaults to: nil) —

      Required. The DeliveryVehicle entity to create. When creating a new delivery vehicle, you may set the following optional fields:

      • type
      • last_location
      • attributes

      Note: The DeliveryVehicle's name field is ignored. All other DeliveryVehicle fields must not be set; otherwise, an error is returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 304

def create_delivery_vehicle request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::CreateDeliveryVehicleRequest

  # 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
  metadata = @config.rpcs.create_delivery_vehicle.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :create_delivery_vehicle, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_task(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task #create_task(header: nil, parent: nil, task_id: nil, task: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

Creates and returns a new Task object.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #create_task(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::CreateTaskRequest, ::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_task(header: nil, parent: nil, task_id: nil, task: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

    Pass arguments to create_task 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

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

      Required. The Task ID must be unique, but it should be not a shipment tracking ID. To store a shipment tracking ID, use the tracking_id field. Note that multiple tasks can have the same tracking_id. Task IDs are 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 '#'.
    • task (::Google::Maps::FleetEngine::Delivery::V1::Task, ::Hash) (defaults to: nil) —

      Required. The Task entity to create. When creating a Task, the following fields are required:

      • type
      • state (must be set to OPEN)
      • tracking_id (must not be set for UNAVAILABLE or SCHEDULED_STOP tasks, but required for all other task types)
      • planned_location (optional for UNAVAILABLE tasks)
      • task_duration

      The following fields can be optionally set:

      • target_time_window
      • task_tracking_view_config
      • attributes

      Note: The Task's name field is ignored. All other Task fields must not be set; otherwise, an error is returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 808

def create_task request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::CreateTaskRequest

  # 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
  metadata = @config.rpcs.create_task.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :create_task, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_delivery_vehicle(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_delivery_vehicle(header: nil, name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a DeliveryVehicle from the Fleet Engine.

Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks assigned to it.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

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

    Pass arguments to delete_delivery_vehicle via a request object, either of type Google::Maps::FleetEngine::Delivery::V1::DeleteDeliveryVehicleRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::DeleteDeliveryVehicleRequest, ::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.

  • #delete_delivery_vehicle(header: nil, name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_delivery_vehicle 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}/deliveryVehicles/{delivery_vehicle}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 489

def delete_delivery_vehicle request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::DeleteDeliveryVehicleRequest

  # 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
  metadata = @config.rpcs.delete_delivery_vehicle.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :delete_delivery_vehicle, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_task(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_task(header: nil, name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a single Task.

Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a DeliveryVehicle.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

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

    Pass arguments to delete_task via a request object, either of type Google::Maps::FleetEngine::Delivery::V1::DeleteTaskRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::DeleteTaskRequest, ::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.

  • #delete_task(header: nil, name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_task 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}/tasks/{task}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 991

def delete_task request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::DeleteTaskRequest

  # 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
  metadata = @config.rpcs.delete_task.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :delete_task, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_delivery_vehicle(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle #get_delivery_vehicle(header: nil, name: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

Returns the specified DeliveryVehicle instance.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #get_delivery_vehicle(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::GetDeliveryVehicleRequest, ::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_delivery_vehicle(header: nil, name: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

    Pass arguments to get_delivery_vehicle 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}/deliveryVehicles/{delivery_vehicle}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 395

def get_delivery_vehicle request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::GetDeliveryVehicleRequest

  # 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
  metadata = @config.rpcs.get_delivery_vehicle.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :get_delivery_vehicle, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_task(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task #get_task(header: nil, name: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

Gets information about a Task.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #get_task(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::GetTaskRequest, ::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_task(header: nil, name: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

    Pass arguments to get_task 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}/tasks/{task}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 898

def get_task request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::GetTaskRequest

  # 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
  metadata = @config.rpcs.get_task.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :get_task, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_task_tracking_info(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingInfo #get_task_tracking_info(header: nil, name: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingInfo

Returns the specified TaskTrackingInfo instance.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #get_task_tracking_info(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingInfo

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::GetTaskTrackingInfoRequest, ::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_task_tracking_info(header: nil, name: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::TaskTrackingInfo

    Pass arguments to get_task_tracking_info 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}/taskTrackingInfo/{tracking_id}. The provider must be the Google Cloud Project ID, and the tracking_id must be the tracking ID associated with the task. An example name can be providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 1304

def get_task_tracking_info request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::GetTaskTrackingInfoRequest

  # 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
  metadata = @config.rpcs.get_task_tracking_info.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :get_task_tracking_info, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_delivery_vehicles(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle> #list_delivery_vehicles(header: nil, parent: nil, page_size: nil, page_token: nil, filter: nil, viewport: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle>

Gets all DeliveryVehicles that meet the specified filtering criteria.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

# Call the list_delivery_vehicles method.
result = client.list_delivery_vehicles 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::Delivery::V1::DeliveryVehicle.
  p item
end

Overloads:

  • #list_delivery_vehicles(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle>

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::ListDeliveryVehiclesRequest, ::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.

  • #list_delivery_vehicles(header: nil, parent: nil, page_size: nil, page_token: nil, filter: nil, viewport: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle>

    Pass arguments to list_delivery_vehicles 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

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

      Optional. The maximum number of vehicles to return. The service may return fewer than this number. If you don't specify this number, then the server determines the number of results to return.

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

      Optional. A page token, received from a previous ListDeliveryVehicles call. You must provide this in order to retrieve the subsequent page.

      When paginating, all other parameters provided to ListDeliveryVehicles must match the call that provided the page token.

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

      Optional. A filter query to apply when listing delivery vehicles. See http://aip.dev/160 for examples of the filter syntax. If you don't specify a value, or if you specify an empty string for the filter, then all delivery vehicles are returned.

      Note that the only queries supported for ListDeliveryVehicles are on vehicle attributes (for example, attributes.<key> = <value> or attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, attributes.<key> = "10" or attributes.<key> = "true").

      The maximum number of restrictions allowed in a filter query is 50. A restriction is a part of the query of the form attribute.<KEY> <COMPARATOR> <VALUE>, for example attributes.foo = bar is 1 restriction.

    • viewport (::Google::Geo::Type::Viewport, ::Hash) (defaults to: nil) —

      Optional. A filter that limits the vehicles returned to those whose last known location was in the rectangular area defined by the viewport.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 1430

def list_delivery_vehicles request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::ListDeliveryVehiclesRequest

  # 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
  metadata = @config.rpcs.list_delivery_vehicles.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :list_delivery_vehicles, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @delivery_service_stub, :list_delivery_vehicles, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_tasks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::Task> #list_tasks(header: nil, parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::Task>

Gets all Tasks that meet the specified filtering criteria.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

# Call the list_tasks method.
result = client.list_tasks 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::Delivery::V1::Task.
  p item
end

Overloads:

  • #list_tasks(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::Task>

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::ListTasksRequest, ::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.

  • #list_tasks(header: nil, parent: nil, page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Maps::FleetEngine::Delivery::V1::Task>

    Pass arguments to list_tasks 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

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

      Required. Must be in the format providers/{provider}. The provider must be the Google Cloud Project ID. For example, sample-cloud-project.

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

      Optional. The maximum number of Tasks to return. The service may return fewer than this value. If you don't specify this value, then the server determines the number of results to return.

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

      Optional. A page token received from a previous ListTasks call. You can provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to ListTasks must match the call that provided the page token.

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

      Optional. A filter query to apply when listing Tasks. See http://aip.dev/160 for examples of filter syntax. If you don't specify a value, or if you filter on an empty string, then all Tasks are returned. For information about the Task properties that you can filter on, see List tasks.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 1210

def list_tasks request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::ListTasksRequest

  # 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
  metadata = @config.rpcs.list_tasks.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"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
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :list_tasks, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @delivery_service_stub, :list_tasks, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


231
232
233
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 231

def logger
  @delivery_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


155
156
157
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 155

def universe_domain
  @delivery_service_stub.universe_domain
end

#update_delivery_vehicle(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle #update_delivery_vehicle(header: nil, delivery_vehicle: nil, update_mask: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicle

Writes updated DeliveryVehicle data to Fleet Engine, and assigns Tasks to the DeliveryVehicle. You cannot update the name of the DeliveryVehicle. You can update remaining_vehicle_journey_segments, but it must contain all of the VehicleJourneySegments to be persisted on the DeliveryVehicle. The task_ids are retrieved from remaining_vehicle_journey_segments, and their corresponding Tasks are assigned to the DeliveryVehicle if they have not yet been assigned.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC 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
626
627
628
629
630
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 590

def update_delivery_vehicle request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::UpdateDeliveryVehicleRequest

  # 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
  metadata = @config.rpcs.update_delivery_vehicle.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.delivery_vehicle&.name &&
     %r{^providers/[^/]+/?$}.match?(request.delivery_vehicle.name)
    header_params["provider_id"] = request.delivery_vehicle.name
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :update_delivery_vehicle, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_task(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task #update_task(header: nil, task: nil, update_mask: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

Updates Task data.

Examples:

Basic example

require "google/maps/fleet_engine/delivery/v1"

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

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

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

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

Overloads:

  • #update_task(request, options = nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

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

    Parameters:

    • request (::Google::Maps::FleetEngine::Delivery::V1::UpdateTaskRequest, ::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_task(header: nil, task: nil, update_mask: nil) ⇒ ::Google::Maps::FleetEngine::Delivery::V1::Task

    Pass arguments to update_task 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::Delivery::V1::DeliveryRequestHeader, ::Hash) (defaults to: nil) —

      Optional. The standard Delivery API request header.

    • task (::Google::Maps::FleetEngine::Delivery::V1::Task, ::Hash) (defaults to: nil) —

      Required. The Task associated with the update. The following fields are maintained by Fleet Engine. Do not update them using Task.update.

      • last_location.
      • last_location_snappable.
      • name.
      • remaining_vehicle_journey_segments.
      • task_outcome_location_source.

      Note: You cannot change the value of task_outcome once you set it.

      If the Task has been assigned to a delivery vehicle, then don't set the Task state to CLOSED using Task.update. Instead, remove the VehicleStop that contains the Task from the delivery vehicle, which automatically sets the Task state to CLOSED.

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

      Required. The field mask that indicates which Task fields to update. Note: The update_mask must contain at least one field.

      This is a comma-separated list of fully qualified names of fields. Example: "task_outcome,task_outcome_time,task_outcome_location".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb', line 1100

def update_task request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Maps::FleetEngine::Delivery::V1::UpdateTaskRequest

  # 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
  metadata = @config.rpcs.update_task.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::Delivery::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.task&.name &&
     %r{^providers/[^/]+/?$}.match?(request.task.name)
    header_params["provider_id"] = request.task.name
  end

  request_params_header = URI.encode_www_form header_params
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @delivery_service_stub.call_rpc :update_task, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end