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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/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

Constructor Details

#initialize(**args) ⇒ FacetBucket

Returns a new instance of FacetBucket.



1380
1381
1382
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1380

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. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned. Corresponds to the JSON property count

Returns:

  • (Fixnum) 


1363
1364
1365
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1363

def count
  @count
end

#percentage ⇒ Fixnum

Percent of results that match the bucket value. The returned value is between ( 0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. 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) 


1373
1374
1375
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1373

def percentage
  @percentage
end

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

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

Returns:



1378
1379
1380
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1378

def value
  @value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1385
1386
1387
1388
1389
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1385

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