Class: Google::Cloud::Notebooks::V2::NotebookService::Rest::Client::Configuration

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

Overview

Configuration class for the NotebookService REST API.

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

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

Examples:


# Modify the global config, setting the timeout for
# list_instances to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Notebooks::V2::NotebookService::Rest::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::V2::NotebookService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.list_instances.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Constant Summary collapse

DEFAULT_ENDPOINT = 
"notebooks.googleapis.com"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

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

Returns:

  • (::String) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

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

Additional headers to be sent with the call.

Returns:

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


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_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) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1067

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "notebooks.googleapis.com"

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

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the 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 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 `update_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_instance
    ##
    # 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 `check_instance_upgradability`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :check_instance_upgradability
    ##
    # RPC-specific configuration for `upgrade_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :upgrade_instance
    ##
    # RPC-specific configuration for `rollback_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rollback_instance
    ##
    # RPC-specific configuration for `diagnose_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :diagnose_instance

    # @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
      update_instance_config = parent_rpcs.update_instance if parent_rpcs.respond_to? :update_instance
      @update_instance = ::Gapic::Config::Method.new update_instance_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
      check_instance_upgradability_config = parent_rpcs.check_instance_upgradability if parent_rpcs.respond_to? :check_instance_upgradability
      @check_instance_upgradability = ::Gapic::Config::Method.new check_instance_upgradability_config
      upgrade_instance_config = parent_rpcs.upgrade_instance if parent_rpcs.respond_to? :upgrade_instance
      @upgrade_instance = ::Gapic::Config::Method.new upgrade_instance_config
      rollback_instance_config = parent_rpcs.rollback_instance if parent_rpcs.respond_to? :rollback_instance
      @rollback_instance = ::Gapic::Config::Method.new rollback_instance_config
      diagnose_instance_config = parent_rpcs.diagnose_instance if parent_rpcs.respond_to? :diagnose_instance
      @diagnose_instance = ::Gapic::Config::Method.new diagnose_instance_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/google/cloud/notebooks/v2/notebook_service/rest/client.rb', line 1103

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