Class: Google::Apis::CloudsearchV1::FacetBucket

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_v1/representations.rb

Overview

A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FacetBucket

Returns a new instance of FacetBucket



888
889
890
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 888

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#count ⇒ Fixnum

Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Can be empty. Corresponds to the JSON property count

Returns:

  • (Fixnum) 


873
874
875
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 873

def count
  @count
end

#percentage ⇒ Fixnum

Percent of results that match the bucket value. This value is between (0-100]. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts. Corresponds to the JSON property percentage

Returns:

  • (Fixnum) 


881
882
883
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 881

def percentage
  @percentage
end

#value ⇒ Google::Apis::CloudsearchV1::Value

Definition of a single value with generic type. Corresponds to the JSON property value

Returns:



886
887
888
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 886

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



893
894
895
896
897
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 893

def update!(**args)
  @count = args[:count] if args.key?(:count)
  @percentage = args[:percentage] if args.key?(:percentage)
  @value = args[:value] if args.key?(:value)
end