Class: Couchbase::SearchFacet::SearchFacetNumericRange

Inherits:

Object

• Object
• Couchbase::SearchFacet::SearchFacetNumericRange

Defined in:

lib/couchbase/search_options.rb

Instance Attribute Summary

• #field ⇒ String readonly
• #size ⇒ Integer

Instance Method Summary

• #add(name, min, max) ⇒ Object
• #initialize(field) {|_self| ... } ⇒ SearchFacetNumericRange constructor

  A new instance of SearchFacetNumericRange.

• #to_json(*args) ⇒ Object private

Constructor Details

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

Returns a new instance of SearchFacetNumericRange.

Parameters:

• field (String) —

  name of the field

Yields:

• (_self)

Yield Parameters:

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

  the object that the method was called on

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

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

Instance Attribute Details

#field ⇒ String (readonly)

Returns:

• (String)

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

def field
  @field
end

#size ⇒ Integer

Returns:

• (Integer)

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

def size
  @size
end

Instance Method Details

#add(name, min, max) ⇒ Object

Parameters:

• name (String) —

  the name of the range

• min (Integer, Float, nil) —

  lower bound of the range (pass nil if there is no lower bound)

• max (Integer, Float, nil) —

  upper bound of the range (pass nil if there is no upper bound)

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

def add(name, min, max)
  @ranges.append({name: name, min: min, max: max})
end

#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 1317

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