Class: Google::Apis::CloudsearchV1::FacetOptions

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

Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FacetOptions

Returns a new instance of FacetOptions.



8975
8976
8977
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8975

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

Instance Attribute Details

#integer_faceting_options ⇒ Google::Apis::CloudsearchV1::IntegerFacetingOptions

Used to specify integer faceting options. Corresponds to the JSON property integerFacetingOptions

Returns:



8949
8950
8951
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8949

def integer_faceting_options
  @integer_faceting_options
end

#num_facet_buckets ⇒ Fixnum

Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100. Corresponds to the JSON property numFacetBuckets

Returns:

  • (Fixnum) 


8955
8956
8957
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8955

def num_facet_buckets
  @num_facet_buckets
end

#object_type ⇒ String

If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets. Corresponds to the JSON property objectType

Returns:

  • (String) 


8961
8962
8963
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8961

def object_type
  @object_type
end

#operator_name ⇒ String

The name of the operator chosen for faceting. @see cloudsearch. SchemaPropertyOptions Corresponds to the JSON property operatorName

Returns:

  • (String) 


8967
8968
8969
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8967

def operator_name
  @operator_name
end

#source_name ⇒ String

Source name to facet on. Format: datasources/source_id If empty, all data sources will be used. Corresponds to the JSON property sourceName

Returns:

  • (String) 


8973
8974
8975
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8973

def source_name
  @source_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8980
8981
8982
8983
8984
8985
8986
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 8980

def update!(**args)
  @integer_faceting_options = args[:integer_faceting_options] if args.key?(:integer_faceting_options)
  @num_facet_buckets = args[:num_facet_buckets] if args.key?(:num_facet_buckets)
  @object_type = args[:object_type] if args.key?(:object_type)
  @operator_name = args[:operator_name] if args.key?(:operator_name)
  @source_name = args[:source_name] if args.key?(:source_name)
end