Class: Google::Cloud::Monitoring::V3::MetricService::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/monitoring/v3/metric_service/client.rb

Overview

Configuration class for the MetricService API.

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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Monitoring::V3::MetricService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_monitored_resource_descriptors.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a GRPC::Core::Channel object is provided as the credential.

Returns:

  • (::Hash) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#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)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials

Returns:

  • (::Object) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_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) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

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

Additional gRPC headers to be sent with the call.

Returns:

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


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_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) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_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) 


1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
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
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1224

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "monitoring.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 += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    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(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, 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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the MetricService 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 gRPC 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 `list_monitored_resource_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_monitored_resource_descriptors
    ##
    # RPC-specific configuration for `get_monitored_resource_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_monitored_resource_descriptor
    ##
    # RPC-specific configuration for `list_metric_descriptors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_metric_descriptors
    ##
    # RPC-specific configuration for `get_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_metric_descriptor
    ##
    # RPC-specific configuration for `create_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_metric_descriptor
    ##
    # RPC-specific configuration for `delete_metric_descriptor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_metric_descriptor
    ##
    # RPC-specific configuration for `list_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_time_series
    ##
    # RPC-specific configuration for `create_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_time_series
    ##
    # RPC-specific configuration for `create_service_time_series`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_service_time_series

    # @private
    def initialize parent_rpcs = nil
      list_monitored_resource_descriptors_config = parent_rpcs.list_monitored_resource_descriptors if parent_rpcs.respond_to? :list_monitored_resource_descriptors
      @list_monitored_resource_descriptors = ::Gapic::Config::Method.new list_monitored_resource_descriptors_config
      get_monitored_resource_descriptor_config = parent_rpcs.get_monitored_resource_descriptor if parent_rpcs.respond_to? :get_monitored_resource_descriptor
      @get_monitored_resource_descriptor = ::Gapic::Config::Method.new get_monitored_resource_descriptor_config
      list_metric_descriptors_config = parent_rpcs.list_metric_descriptors if parent_rpcs.respond_to? :list_metric_descriptors
      @list_metric_descriptors = ::Gapic::Config::Method.new list_metric_descriptors_config
      get_metric_descriptor_config = parent_rpcs.get_metric_descriptor if parent_rpcs.respond_to? :get_metric_descriptor
      @get_metric_descriptor = ::Gapic::Config::Method.new get_metric_descriptor_config
      create_metric_descriptor_config = parent_rpcs.create_metric_descriptor if parent_rpcs.respond_to? :create_metric_descriptor
      @create_metric_descriptor = ::Gapic::Config::Method.new create_metric_descriptor_config
      delete_metric_descriptor_config = parent_rpcs.delete_metric_descriptor if parent_rpcs.respond_to? :delete_metric_descriptor
      @delete_metric_descriptor = ::Gapic::Config::Method.new delete_metric_descriptor_config
      list_time_series_config = parent_rpcs.list_time_series if parent_rpcs.respond_to? :list_time_series
      @list_time_series = ::Gapic::Config::Method.new list_time_series_config
      create_time_series_config = parent_rpcs.create_time_series if parent_rpcs.respond_to? :create_time_series
      @create_time_series = ::Gapic::Config::Method.new create_time_series_config
      create_service_time_series_config = parent_rpcs.create_service_time_series if parent_rpcs.respond_to? :create_service_time_series
      @create_service_time_series = ::Gapic::Config::Method.new create_service_time_series_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#channel_pool ⇒ ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns:

  • (::Gapic::ServiceStub::ChannelPool::Configuration) 


1271
1272
1273
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1271

def channel_pool
  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1259
1260
1261
1262
1263
1264
1265
 
# File 'lib/google/cloud/monitoring/v3/metric_service/client.rb', line 1259

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