Class: Couchbase::SearchFacet::SearchFacetTerm

Inherits:

Object

• Object
• Couchbase::SearchFacet::SearchFacetTerm

Defined in:

lib/couchbase/search_options.rb

Instance Attribute Summary

• #field ⇒ String readonly
• #size ⇒ Integer

Instance Method Summary

• #initialize(field) {|_self| ... } ⇒ SearchFacetTerm constructor

  A new instance of SearchFacetTerm.

• #to_json(*args) ⇒ Object private

Constructor Details

#initialize(field) {|_self| ... } ⇒ SearchFacetTerm

Returns a new instance of SearchFacetTerm.

Parameters:

• field (String) —

  name of the field

Yields:

• (_self)

Yield Parameters:

• _self (Couchbase::SearchFacet::SearchFacetTerm) —

  the object that the method was called on

# File 'lib/couchbase/search_options.rb', line 1289

def initialize(field)
  @field = field
  yield self if block_given?
end

Instance Attribute Details

#field ⇒ String (readonly)

Returns:

• (String)

# File 'lib/couchbase/search_options.rb', line 1283

def field
  @field
end

#size ⇒ Integer

Returns:

• (Integer)

# File 'lib/couchbase/search_options.rb', line 1286

def size
  @size
end

Instance Method Details

#to_json(*args) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/couchbase/search_options.rb', line 1295

def to_json(*args)
  {field: field, size: size}.to_json(*args)
end