RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Seahorse/Client/Base.html below:

Base — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Seahorse::Client::Base

Inherits:

Object

Object
Seahorse::Client::Base

show all

Includes:: HandlerBuilder

Defined in:: aws-sdk-core/lib/seahorse/client/base.rb

Direct Known Subclasses

Instance Attribute Summary collapse

#config ⇒ Configuration<Struct> readonly
#handlers ⇒ HandlerList readonly

Class Method Summary collapse

.add_plugin(plugin) ⇒ void Registers a plugin with this client.
.api ⇒ Model::Api
.clear_plugins ⇒ void
.define(options = {}) ⇒ Class<Client::Base> (also: extend)
.new(options = {}) ⇒ Object
.plugins ⇒ Array<Plugin> Returns the list of registered plugins for this Client.
.remove_plugin(plugin) ⇒ void
.set_api(api) ⇒ Model::Api
.set_plugins(plugins) ⇒ void

Instance Method Summary collapse

#build_request(operation_name, params = {}) ⇒ Request Builds and returns a Request for the named operation.
#operation(name) ⇒ Model::Operation
#operation_names ⇒ Array<Symbol> Returns a list of valid request operation names.

Methods included from HandlerBuilder

#handle, #handle_request, #handle_response

Instance Attribute Details #config ⇒ Configuration<Struct>

25
26
27

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 25

def config
  @config
end

#handlers ⇒ HandlerList

28
29
30

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 28

def handlers
  @handlers
end

Class Method Details .add_plugin(plugin) ⇒ void

This method returns an undefined value.

Registers a plugin with this client.

130
131
132

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 130

def add_plugin(plugin)
  @plugins.add(plugin)
end

.api ⇒ Model::Api

174
175
176

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 174

def api
  @api ||= Model::Api.new
end

.clear_plugins ⇒ void

This method returns an undefined value.

148
149
150

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 148

def clear_plugins
  @plugins.set([])
end

.define(options = {}) ⇒ Class<Client::Base> Also known as: extend

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 190

def define(options = {})
  subclass = Class.new(self)
  subclass.set_api(options[:api] || api)
  Array(options[:plugins]).each do |plugin|
    subclass.add_plugin(plugin)
  end
  subclass
end

.new(options = {}) ⇒ Object

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 100

def new(options = {})
  plugins = build_plugins
  options = options.dup
  before_initialize(plugins, options)
  client = allocate
  client.send(:initialize, plugins, options)
  client
end

.plugins ⇒ Array<Plugin>

Returns the list of registered plugins for this Client. Plugins are inherited from the client super class when the client is defined.

169
170
171

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 169

def plugins
  Array(@plugins).freeze
end

.remove_plugin(plugin) ⇒ void

This method returns an undefined value.

139
140
141

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 139

def remove_plugin(plugin)
  @plugins.remove(plugin)
end

.set_api(api) ⇒ Model::Api

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 180

def set_api(api)
  @api = api
  define_operation_methods
  @api
end

.set_plugins(plugins) ⇒ void

This method returns an undefined value.

158
159
160

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 158

def set_plugins(plugins)
  @plugins.set(plugins)
end

Instance Method Details #build_request(operation_name, params = {}) ⇒ Request

Builds and returns a Request for the named operation. The request will not have been sent.

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 34

def build_request(operation_name, params = {})
  Request.new(
    @handlers.for(operation_name),
    context_for(operation_name, params))
end

#operation(name) ⇒ Model::Operation

42
43
44

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 42

def operation(name)
  config.api.operation(name)
end

#operation_names ⇒ Array<Symbol>

Returns a list of valid request operation names. These are valid arguments to #build_request and are also valid methods.

54
55
56

# File 'aws-sdk-core/lib/seahorse/client/base.rb', line 54

def operation_names
  self.class.api.operation_names
end

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4