Class: Google::Cloud::Notebooks::V1beta1::NotebookService::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb

Overview

Configuration class for the NotebookService API.

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

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Notebooks::V1beta1::NotebookService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_instances.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) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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>) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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}) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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) 


2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2174

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "notebooks.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 NotebookService 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_instances`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_instances
    ##
    # RPC-specific configuration for `get_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_instance
    ##
    # RPC-specific configuration for `create_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_instance
    ##
    # RPC-specific configuration for `register_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :register_instance
    ##
    # RPC-specific configuration for `set_instance_accelerator`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_accelerator
    ##
    # RPC-specific configuration for `set_instance_machine_type`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_machine_type
    ##
    # RPC-specific configuration for `set_instance_labels`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_instance_labels
    ##
    # RPC-specific configuration for `delete_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_instance
    ##
    # RPC-specific configuration for `start_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :start_instance
    ##
    # RPC-specific configuration for `stop_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :stop_instance
    ##
    # RPC-specific configuration for `reset_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :reset_instance
    ##
    # RPC-specific configuration for `report_instance_info`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :report_instance_info
    ##
    # RPC-specific configuration for `is_instance_upgradeable`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :is_instance_upgradeable
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `upgrade_instance_internal`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance_internal
    ##
    # RPC-specific configuration for `list_environments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_environments
    ##
    # RPC-specific configuration for `get_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_environment
    ##
    # RPC-specific configuration for `create_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_environment
    ##
    # RPC-specific configuration for `delete_environment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_environment

    # @private
    def initialize parent_rpcs = nil
      list_instances_config = parent_rpcs.list_instances if parent_rpcs.respond_to? :list_instances
      @list_instances = ::Gapic::Config::Method.new list_instances_config
      get_instance_config = parent_rpcs.get_instance if parent_rpcs.respond_to? :get_instance
      @get_instance = ::Gapic::Config::Method.new get_instance_config
      create_instance_config = parent_rpcs.create_instance if parent_rpcs.respond_to? :create_instance
      @create_instance = ::Gapic::Config::Method.new create_instance_config
      register_instance_config = parent_rpcs.register_instance if parent_rpcs.respond_to? :register_instance
      @register_instance = ::Gapic::Config::Method.new register_instance_config
      set_instance_accelerator_config = parent_rpcs.set_instance_accelerator if parent_rpcs.respond_to? :set_instance_accelerator
      @set_instance_accelerator = ::Gapic::Config::Method.new set_instance_accelerator_config
      set_instance_machine_type_config = parent_rpcs.set_instance_machine_type if parent_rpcs.respond_to? :set_instance_machine_type
      @set_instance_machine_type = ::Gapic::Config::Method.new set_instance_machine_type_config
      set_instance_labels_config = parent_rpcs.set_instance_labels if parent_rpcs.respond_to? :set_instance_labels
      @set_instance_labels = ::Gapic::Config::Method.new set_instance_labels_config
      delete_instance_config = parent_rpcs.delete_instance if parent_rpcs.respond_to? :delete_instance
      @delete_instance = ::Gapic::Config::Method.new delete_instance_config
      start_instance_config = parent_rpcs.start_instance if parent_rpcs.respond_to? :start_instance
      @start_instance = ::Gapic::Config::Method.new start_instance_config
      stop_instance_config = parent_rpcs.stop_instance if parent_rpcs.respond_to? :stop_instance
      @stop_instance = ::Gapic::Config::Method.new stop_instance_config
      reset_instance_config = parent_rpcs.reset_instance if parent_rpcs.respond_to? :reset_instance
      @reset_instance = ::Gapic::Config::Method.new reset_instance_config
      report_instance_info_config = parent_rpcs.report_instance_info if parent_rpcs.respond_to? :report_instance_info
      @report_instance_info = ::Gapic::Config::Method.new report_instance_info_config
      is_instance_upgradeable_config = parent_rpcs.is_instance_upgradeable if parent_rpcs.respond_to? :is_instance_upgradeable
      @is_instance_upgradeable = ::Gapic::Config::Method.new is_instance_upgradeable_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      upgrade_instance_internal_config = parent_rpcs.upgrade_instance_internal if parent_rpcs.respond_to? :upgrade_instance_internal
      @upgrade_instance_internal = ::Gapic::Config::Method.new upgrade_instance_internal_config
      list_environments_config = parent_rpcs.list_environments if parent_rpcs.respond_to? :list_environments
      @list_environments = ::Gapic::Config::Method.new list_environments_config
      get_environment_config = parent_rpcs.get_environment if parent_rpcs.respond_to? :get_environment
      @get_environment = ::Gapic::Config::Method.new get_environment_config
      create_environment_config = parent_rpcs.create_environment if parent_rpcs.respond_to? :create_environment
      @create_environment = ::Gapic::Config::Method.new create_environment_config
      delete_environment_config = parent_rpcs.delete_environment if parent_rpcs.respond_to? :delete_environment
      @delete_environment = ::Gapic::Config::Method.new delete_environment_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) 


2221
2222
2223
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2221

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

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



2209
2210
2211
2212
2213
2214
2215
 
# File 'lib/google/cloud/notebooks/v1beta1/notebook_service/client.rb', line 2209

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