Class: Couchbase::Cluster::SearchFacet::SearchFacetNumericRange

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/search_options.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of SearchFacetNumericRange.

Parameters:

  • field (String)

    name of the field

Yields:

  • (_self)

Yield Parameters:



1157
1158
1159
1160
1161
# File 'lib/couchbase/search_options.rb', line 1157

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

Instance Attribute Details

#fieldString (readonly)

Returns:

  • (String)


1151
1152
1153
# File 'lib/couchbase/search_options.rb', line 1151

def field
  @field
end

#sizeInteger

Returns:

  • (Integer)


1154
1155
1156
# File 'lib/couchbase/search_options.rb', line 1154

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)



1166
1167
1168
# File 'lib/couchbase/search_options.rb', line 1166

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