Class: Seahorse::Client::Base

Inherits:

Object

Object
Seahorse::Client::Base

show all

Includes:: HandlerBuilder

Defined in:: gems/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_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>` (readonly)

Returns:

(Configuration<Struct>)



27
28
29

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

def config
  @config
end

#handlers ⇒ `HandlerList` (readonly)

Returns:

(HandlerList)



30
31
32

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

def handlers
  @handlers
end

Class Method Details

.add_plugin(plugin) ⇒ `void`

This method returns an undefined value.

Registers a plugin with this client.

Examples:

Register a plugin


ClientClass.add_plugin(PluginClass)

Register a plugin by name


ClientClass.add_plugin('gem-name.PluginClass')

Register a plugin with an object


plugin = MyPluginClass.new(options)
ClientClass.add_plugin(plugin)

Parameters:

plugin (Class, Symbol, String, Object)

See Also:

clear_plugins
set_plugins
remove_plugin
plugins



127
128
129

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

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

.api ⇒ `Model::Api`

Returns:

(Model::Api)



171
172
173

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

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

.clear_plugins ⇒ `void`

This method returns an undefined value.

See Also:

set_plugins
add_plugin
remove_plugin
plugins



145
146
147

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

def clear_plugins
  @plugins.set([])
end

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

Parameters:

options (Hash) (defaults to: {}) —
a customizable set of options

Options Hash (options):

:api (Model::Api, Hash) — default: {}
:plugins (Array<Plugin>) — default: [] —
A list of plugins to add to the client class created.

Returns:

(Class<Client::Base>)

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

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 'gems/aws-sdk-core/lib/seahorse/client/base.rb', line 97

def new(options = {})
  options = options.dup
  plugins = build_plugins(self.plugins + options.fetch(:plugins, []))
  plugins = 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.

Returns:

(Array<Plugin>)

See Also:

clear_plugins
set_plugins
add_plugin
remove_plugin



166
167
168

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

def plugins
  Array(@plugins).freeze
end

.remove_plugin(plugin) ⇒ `void`

This method returns an undefined value.

See Also:

clear_plugins
set_plugins
add_plugin
plugins



136
137
138

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

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

.set_api(api) ⇒ `Model::Api`

Parameters:

api (Model::Api)

Returns:

(Model::Api)

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

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

.set_plugins(plugins) ⇒ `void`

This method returns an undefined value.

Parameters:

plugins (Array<Plugin>)

See Also:

clear_plugins
add_plugin
remove_plugin
plugins



155
156
157

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

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.

Parameters:

operation_name (Symbol, String)

Returns:

(Request)

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

def build_request(operation_name, params = {})
  Request.new(
    @handlers.for(operation_name),
    context_for(operation_name, params))
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.

Returns:

(Array<Symbol>) —
Returns a list of valid request operation names. These are valid arguments to #build_request and are also valid methods.



50
51
52

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

def operation_names
  self.class.api.operation_names - self.class.api.async_operation_names
end

Class: Seahorse::Client::Base

Direct Known Subclasses

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HandlerBuilder

Instance Attribute Details

#config ⇒ Configuration<Struct> (readonly)

#handlers ⇒ HandlerList (readonly)

Class Method Details

.add_plugin(plugin) ⇒ void

Examples:

Register a plugin

Register a plugin by name

Register a plugin with an object

.api ⇒ Model::Api

.clear_plugins ⇒ void

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

.new(options = {}) ⇒ Object

.plugins ⇒ Array<Plugin>

.remove_plugin(plugin) ⇒ void

.set_api(api) ⇒ Model::Api

.set_plugins(plugins) ⇒ void

Instance Method Details

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

#operation_names ⇒ Array<Symbol>

#config ⇒ `Configuration<Struct>` (readonly)

#handlers ⇒ `HandlerList` (readonly)

.add_plugin(plugin) ⇒ `void`

.api ⇒ `Model::Api`

.clear_plugins ⇒ `void`

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

.new(options = {}) ⇒ `Object`

.plugins ⇒ `Array<Plugin>`

.remove_plugin(plugin) ⇒ `void`

.set_api(api) ⇒ `Model::Api`

.set_plugins(plugins) ⇒ `void`

#build_request(operation_name, params = {}) ⇒ `Request`

#operation_names ⇒ `Array<Symbol>`