Class: Google::Cloud::Compute::V1::Networks::Rest::Client::Configuration

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

Overview

Configuration class for the Networks REST API.

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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Compute::V1::Networks::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.add_peering.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Constant Summary collapse

DEFAULT_ENDPOINT =
"compute.googleapis.com"

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


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

#endpoint::String

The hostname or hostname:port of the service endpoint. Defaults to "compute.googleapis.com".



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

#lib_name::String

The library name as recorded in instrumentation and logging



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

#lib_version::String

The library version as recorded in instrumentation and logging



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

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

Additional headers to be sent with the call.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

#quota_project::String

A separate project against which to charge quota.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_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.


1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

#scope::Array<::String>

The OAuth scopes



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

#timeout::Numeric

The call timeout in seconds.



1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1239

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "compute.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  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

  # @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 Networks 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 `add_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_peering
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_effective_firewalls`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_effective_firewalls
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `list_peering_routes`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_peering_routes
    ##
    # RPC-specific configuration for `patch`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :patch
    ##
    # RPC-specific configuration for `remove_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_peering
    ##
    # RPC-specific configuration for `switch_to_custom_mode`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :switch_to_custom_mode
    ##
    # RPC-specific configuration for `update_peering`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_peering

    # @private
    def initialize parent_rpcs = nil
      add_peering_config = parent_rpcs.add_peering if parent_rpcs.respond_to? :add_peering
      @add_peering = ::Gapic::Config::Method.new add_peering_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_effective_firewalls_config = parent_rpcs.get_effective_firewalls if parent_rpcs.respond_to? :get_effective_firewalls
      @get_effective_firewalls = ::Gapic::Config::Method.new get_effective_firewalls_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      list_peering_routes_config = parent_rpcs.list_peering_routes if parent_rpcs.respond_to? :list_peering_routes
      @list_peering_routes = ::Gapic::Config::Method.new list_peering_routes_config
      patch_config = parent_rpcs.patch if parent_rpcs.respond_to? :patch
      @patch = ::Gapic::Config::Method.new patch_config
      remove_peering_config = parent_rpcs.remove_peering if parent_rpcs.respond_to? :remove_peering
      @remove_peering = ::Gapic::Config::Method.new remove_peering_config
      switch_to_custom_mode_config = parent_rpcs.switch_to_custom_mode if parent_rpcs.respond_to? :switch_to_custom_mode
      @switch_to_custom_mode = ::Gapic::Config::Method.new switch_to_custom_mode_config
      update_peering_config = parent_rpcs.update_peering if parent_rpcs.respond_to? :update_peering
      @update_peering = ::Gapic::Config::Method.new update_peering_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcsRpcs

Configurations for individual RPCs



1268
1269
1270
1271
1272
1273
1274
# File 'lib/google/cloud/compute/v1/networks/rest/client.rb', line 1268

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