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

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

Overview

Configuration class for the TargetPools REST API.

This class represents the configuration for TargetPools REST, providing control over credentials, timeouts, retry behavior, logging.

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

Examples

To modify the global config, setting the timeout for all calls to 10 seconds:

::Google::Cloud::Compute::V1::TargetPools::Client.configure do |config|
  config.timeout = 10.0
end

To apply the above configuration only to a new client:

client = ::Google::Cloud::Compute::V1::TargetPools::Client.new do |config|
  config.timeout = 10.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

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

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

Returns:

  • (::Object) 


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

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

Returns:

  • (::String) 


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

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

Additional REST headers to be sent with the call.

Returns:

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


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1082

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "compute.googleapis.com", ::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

  # @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 TargetPools 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
  #
  # there is one other field (`retry_policy`) that can be set
  # but is currently not supported for REST Gapic libraries.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `add_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_health_check
    ##
    # RPC-specific configuration for `add_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :add_instance
    ##
    # RPC-specific configuration for `aggregated_list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :aggregated_list
    ##
    # RPC-specific configuration for `delete`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete
    ##
    # RPC-specific configuration for `get`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get
    ##
    # RPC-specific configuration for `get_health`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_health
    ##
    # RPC-specific configuration for `insert`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :insert
    ##
    # RPC-specific configuration for `list`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list
    ##
    # RPC-specific configuration for `remove_health_check`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_health_check
    ##
    # RPC-specific configuration for `remove_instance`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :remove_instance
    ##
    # RPC-specific configuration for `set_backup`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :set_backup

    # @private
    def initialize parent_rpcs = nil
      add_health_check_config = parent_rpcs.add_health_check if parent_rpcs.respond_to? :add_health_check
      @add_health_check = ::Gapic::Config::Method.new add_health_check_config
      add_instance_config = parent_rpcs.add_instance if parent_rpcs.respond_to? :add_instance
      @add_instance = ::Gapic::Config::Method.new add_instance_config
      aggregated_list_config = parent_rpcs.aggregated_list if parent_rpcs.respond_to? :aggregated_list
      @aggregated_list = ::Gapic::Config::Method.new aggregated_list_config
      delete_config = parent_rpcs.delete if parent_rpcs.respond_to? :delete
      @delete = ::Gapic::Config::Method.new delete_config
      get_config = parent_rpcs.get if parent_rpcs.respond_to? :get
      @get = ::Gapic::Config::Method.new get_config
      get_health_config = parent_rpcs.get_health if parent_rpcs.respond_to? :get_health
      @get_health = ::Gapic::Config::Method.new get_health_config
      insert_config = parent_rpcs.insert if parent_rpcs.respond_to? :insert
      @insert = ::Gapic::Config::Method.new insert_config
      list_config = parent_rpcs.list if parent_rpcs.respond_to? :list
      @list = ::Gapic::Config::Method.new list_config
      remove_health_check_config = parent_rpcs.remove_health_check if parent_rpcs.respond_to? :remove_health_check
      @remove_health_check = ::Gapic::Config::Method.new remove_health_check_config
      remove_instance_config = parent_rpcs.remove_instance if parent_rpcs.respond_to? :remove_instance
      @remove_instance = ::Gapic::Config::Method.new remove_instance_config
      set_backup_config = parent_rpcs.set_backup if parent_rpcs.respond_to? :set_backup
      @set_backup = ::Gapic::Config::Method.new set_backup_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1107
1108
1109
1110
1111
1112
1113
 
# File 'lib/google/cloud/compute/v1/target_pools/rest/client.rb', line 1107

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