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

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

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

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

#to_json

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

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ FacetOptions

Returns a new instance of FacetOptions



933
934
935
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 933

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

Instance Attribute Details

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


913
914
915
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 913

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) 


919
920
921
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 919

def object_type
  @object_type
end

#operator_name ⇒ String

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

Returns:

  • (String) 


925
926
927
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 925

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) 


931
932
933
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 931

def source_name
  @source_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



938
939
940
941
942
943
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 938

def update!(**args)
  @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