Module: OpenSearch::Sugar

Defined in:
lib/opensearch/sugar.rb,
lib/opensearch/sugar.rb,
lib/opensearch/sugar/index.rb,
lib/opensearch/sugar/client.rb,
lib/opensearch/sugar/models.rb,
lib/opensearch/sugar/version.rb,
sig/opensearch/sugar.rbs

Overview

Top-level namespace for the opensearch-sugar gem.

Provides a thin, object-oriented wrapper around the opensearch-ruby client. The main entry point is Sugar.client, which returns a fully configured Client.

See Also:

Defined Under Namespace

Classes: Client, Error, Index, Models

Constant Summary collapse

VERSION =

Current gem version.

Returns:

  • (String) 
"1.0.0"

Class Method Summary collapse

Class Method Details

.client(**kwargs) ⇒ Client

Convenience factory — returns a new Client.

Parameters:

  • kwargs (Object)

Returns:



47
48
49
 
# File 'lib/opensearch/sugar.rb', line 47

def self.client(**kwargs)
  OpenSearch::Sugar::Client.new(**kwargs)
end

.new(**kwargs) ⇒ Client

Alias for .client.

Parameters:

  • kwargs (Object)

Returns:



57
58
59
 
# File 'lib/opensearch/sugar.rb', line 57

def self.new(**kwargs)
  client(**kwargs)
end