Class: Google::Apis::CloudsearchV1::FacetOptions
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::FacetOptions
- 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
-
#num_facet_buckets ⇒ Fixnum
Maximum number of facet buckets that should be returned for this facet.
-
#object_type ⇒ String
If object_type is set, only those objects of that type will be used to compute facets.
-
#operator_name ⇒ String
Name of the operator chosen for faceting.
-
#source_name ⇒ String
Source name to facet on.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FacetOptions
constructor
A new instance of FacetOptions.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ FacetOptions
Returns a new instance of FacetOptions.
1033 1034 1035 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1033 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
1013 1014 1015 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1013 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
1019 1020 1021 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1019 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
1025 1026 1027 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1025 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
1031 1032 1033 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1031 def source_name @source_name end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1038 1039 1040 1041 1042 1043 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1038 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 |