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

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb

Overview

Configuration class for the DeliveryService REST API.

This class represents the configuration for DeliveryService REST, providing control over timeouts, retry behavior, logging, transport parameters, and other low-level controls. Certain parameters can also be applied individually to specific RPCs. See Rpcs for a list of RPCs that can be configured independently.

Configuration can be applied globally to all clients, or to a single client on construction.

Examples:


# Modify the global config, setting the timeout for
# create_delivery_vehicle to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Maps::FleetEngine::Delivery::V1::DeliveryService::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.create_delivery_vehicle.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Maps::FleetEngine::Delivery::V1::DeliveryService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_delivery_vehicle.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

Credentials to send with calls. You may provide any of the following types:

  • (String) The path to a service account key file in JSON format
  • (Hash) A service account key as a Hash
  • (Google::Auth::Credentials) A googleauth credentials object (see the googleauth docs)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (nil) indicating no credentials

Returns:

  • (::Object) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String?

A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.

Returns:

  • (::String, nil) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#metadata ⇒ ::Hash{::Symbol=>::String}

Additional headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String}) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#retry_policy ⇒ ::Hash

The retry policy. The value is a hash with the following keys:

  • :initial_delay (type: Numeric) - The initial delay in seconds.
  • :max_delay (type: Numeric) - The max delay in seconds.
  • :multiplier (type: Numeric) - The incremental backoff multiplier.
  • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Returns:

  • (::Hash) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ ::String?

The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default "googleapis.com" universe).

Returns:

  • (::String, nil) 


1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
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
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1257

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "fleetengine.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil
  config_attr :universe_domain, nil, ::String, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DeliveryService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `create_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_delivery_vehicle
    ##
    # RPC-specific configuration for `get_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_delivery_vehicle
    ##
    # RPC-specific configuration for `update_delivery_vehicle`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_delivery_vehicle
    ##
    # RPC-specific configuration for `batch_create_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_create_tasks
    ##
    # RPC-specific configuration for `create_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_task
    ##
    # RPC-specific configuration for `get_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task
    ##
    # RPC-specific configuration for `update_task`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_task
    ##
    # RPC-specific configuration for `list_tasks`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_tasks
    ##
    # RPC-specific configuration for `get_task_tracking_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_task_tracking_info
    ##
    # RPC-specific configuration for `list_delivery_vehicles`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_delivery_vehicles

    # @private
    def initialize parent_rpcs = nil
      create_delivery_vehicle_config = parent_rpcs.create_delivery_vehicle if parent_rpcs.respond_to? :create_delivery_vehicle
      @create_delivery_vehicle = ::Gapic::Config::Method.new create_delivery_vehicle_config
      get_delivery_vehicle_config = parent_rpcs.get_delivery_vehicle if parent_rpcs.respond_to? :get_delivery_vehicle
      @get_delivery_vehicle = ::Gapic::Config::Method.new get_delivery_vehicle_config
      update_delivery_vehicle_config = parent_rpcs.update_delivery_vehicle if parent_rpcs.respond_to? :update_delivery_vehicle
      @update_delivery_vehicle = ::Gapic::Config::Method.new update_delivery_vehicle_config
      batch_create_tasks_config = parent_rpcs.batch_create_tasks if parent_rpcs.respond_to? :batch_create_tasks
      @batch_create_tasks = ::Gapic::Config::Method.new batch_create_tasks_config
      create_task_config = parent_rpcs.create_task if parent_rpcs.respond_to? :create_task
      @create_task = ::Gapic::Config::Method.new create_task_config
      get_task_config = parent_rpcs.get_task if parent_rpcs.respond_to? :get_task
      @get_task = ::Gapic::Config::Method.new get_task_config
      update_task_config = parent_rpcs.update_task if parent_rpcs.respond_to? :update_task
      @update_task = ::Gapic::Config::Method.new update_task_config
      list_tasks_config = parent_rpcs.list_tasks if parent_rpcs.respond_to? :list_tasks
      @list_tasks = ::Gapic::Config::Method.new list_tasks_config
      get_task_tracking_info_config = parent_rpcs.get_task_tracking_info if parent_rpcs.respond_to? :get_task_tracking_info
      @get_task_tracking_info = ::Gapic::Config::Method.new get_task_tracking_info_config
      list_delivery_vehicles_config = parent_rpcs.list_delivery_vehicles if parent_rpcs.respond_to? :list_delivery_vehicles
      @list_delivery_vehicles = ::Gapic::Config::Method.new list_delivery_vehicles_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb', line 1289

def rpcs
  @rpcs ||= begin
    parent_rpcs = nil
    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
    Rpcs.new parent_rpcs
  end
end