Class: Google::Cloud::Bigquery::Reservation::V1::ReservationService::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb

Overview

Configuration class for the ReservationService REST API.

This class represents the configuration for ReservationService 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_reservation to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.create_reservation.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.create_reservation.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) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_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) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_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}) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_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) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_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) 


2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2260

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "bigqueryreservation.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 ReservationService 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_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_reservation
    ##
    # RPC-specific configuration for `list_reservations`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_reservations
    ##
    # RPC-specific configuration for `get_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_reservation
    ##
    # RPC-specific configuration for `delete_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_reservation
    ##
    # RPC-specific configuration for `update_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_reservation
    ##
    # RPC-specific configuration for `create_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_capacity_commitment
    ##
    # RPC-specific configuration for `list_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_capacity_commitments
    ##
    # RPC-specific configuration for `get_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_capacity_commitment
    ##
    # RPC-specific configuration for `delete_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_capacity_commitment
    ##
    # RPC-specific configuration for `update_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_capacity_commitment
    ##
    # RPC-specific configuration for `split_capacity_commitment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :split_capacity_commitment
    ##
    # RPC-specific configuration for `merge_capacity_commitments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :merge_capacity_commitments
    ##
    # RPC-specific configuration for `create_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_assignment
    ##
    # RPC-specific configuration for `list_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_assignments
    ##
    # RPC-specific configuration for `delete_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_assignment
    ##
    # RPC-specific configuration for `search_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_assignments
    ##
    # RPC-specific configuration for `search_all_assignments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :search_all_assignments
    ##
    # RPC-specific configuration for `move_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :move_assignment
    ##
    # RPC-specific configuration for `update_assignment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_assignment
    ##
    # RPC-specific configuration for `get_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_bi_reservation
    ##
    # RPC-specific configuration for `update_bi_reservation`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_bi_reservation

    # @private
    def initialize parent_rpcs = nil
      create_reservation_config = parent_rpcs.create_reservation if parent_rpcs.respond_to? :create_reservation
      @create_reservation = ::Gapic::Config::Method.new create_reservation_config
      list_reservations_config = parent_rpcs.list_reservations if parent_rpcs.respond_to? :list_reservations
      @list_reservations = ::Gapic::Config::Method.new list_reservations_config
      get_reservation_config = parent_rpcs.get_reservation if parent_rpcs.respond_to? :get_reservation
      @get_reservation = ::Gapic::Config::Method.new get_reservation_config
      delete_reservation_config = parent_rpcs.delete_reservation if parent_rpcs.respond_to? :delete_reservation
      @delete_reservation = ::Gapic::Config::Method.new delete_reservation_config
      update_reservation_config = parent_rpcs.update_reservation if parent_rpcs.respond_to? :update_reservation
      @update_reservation = ::Gapic::Config::Method.new update_reservation_config
      create_capacity_commitment_config = parent_rpcs.create_capacity_commitment if parent_rpcs.respond_to? :create_capacity_commitment
      @create_capacity_commitment = ::Gapic::Config::Method.new create_capacity_commitment_config
      list_capacity_commitments_config = parent_rpcs.list_capacity_commitments if parent_rpcs.respond_to? :list_capacity_commitments
      @list_capacity_commitments = ::Gapic::Config::Method.new list_capacity_commitments_config
      get_capacity_commitment_config = parent_rpcs.get_capacity_commitment if parent_rpcs.respond_to? :get_capacity_commitment
      @get_capacity_commitment = ::Gapic::Config::Method.new get_capacity_commitment_config
      delete_capacity_commitment_config = parent_rpcs.delete_capacity_commitment if parent_rpcs.respond_to? :delete_capacity_commitment
      @delete_capacity_commitment = ::Gapic::Config::Method.new delete_capacity_commitment_config
      update_capacity_commitment_config = parent_rpcs.update_capacity_commitment if parent_rpcs.respond_to? :update_capacity_commitment
      @update_capacity_commitment = ::Gapic::Config::Method.new update_capacity_commitment_config
      split_capacity_commitment_config = parent_rpcs.split_capacity_commitment if parent_rpcs.respond_to? :split_capacity_commitment
      @split_capacity_commitment = ::Gapic::Config::Method.new split_capacity_commitment_config
      merge_capacity_commitments_config = parent_rpcs.merge_capacity_commitments if parent_rpcs.respond_to? :merge_capacity_commitments
      @merge_capacity_commitments = ::Gapic::Config::Method.new merge_capacity_commitments_config
      create_assignment_config = parent_rpcs.create_assignment if parent_rpcs.respond_to? :create_assignment
      @create_assignment = ::Gapic::Config::Method.new create_assignment_config
      list_assignments_config = parent_rpcs.list_assignments if parent_rpcs.respond_to? :list_assignments
      @list_assignments = ::Gapic::Config::Method.new list_assignments_config
      delete_assignment_config = parent_rpcs.delete_assignment if parent_rpcs.respond_to? :delete_assignment
      @delete_assignment = ::Gapic::Config::Method.new delete_assignment_config
      search_assignments_config = parent_rpcs.search_assignments if parent_rpcs.respond_to? :search_assignments
      @search_assignments = ::Gapic::Config::Method.new search_assignments_config
      search_all_assignments_config = parent_rpcs.search_all_assignments if parent_rpcs.respond_to? :search_all_assignments
      @search_all_assignments = ::Gapic::Config::Method.new search_all_assignments_config
      move_assignment_config = parent_rpcs.move_assignment if parent_rpcs.respond_to? :move_assignment
      @move_assignment = ::Gapic::Config::Method.new move_assignment_config
      update_assignment_config = parent_rpcs.update_assignment if parent_rpcs.respond_to? :update_assignment
      @update_assignment = ::Gapic::Config::Method.new update_assignment_config
      get_bi_reservation_config = parent_rpcs.get_bi_reservation if parent_rpcs.respond_to? :get_bi_reservation
      @get_bi_reservation = ::Gapic::Config::Method.new get_bi_reservation_config
      update_bi_reservation_config = parent_rpcs.update_bi_reservation if parent_rpcs.respond_to? :update_bi_reservation
      @update_bi_reservation = ::Gapic::Config::Method.new update_bi_reservation_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2292
2293
2294
2295
2296
2297
2298
 
# File 'lib/google/cloud/bigquery/reservation/v1/reservation_service/rest/client.rb', line 2292

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