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.



1034
1035
1036
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1034

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

Instance Attribute Details

#num_facet_bucketsFixnum

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)


1014
1015
1016
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1014

def num_facet_buckets
  @num_facet_buckets
end

#object_typeString

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)


1020
1021
1022
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1020

def object_type
  @object_type
end

#operator_nameString

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

Returns:

  • (String)


1026
1027
1028
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1026

def operator_name
  @operator_name
end

#source_nameString

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)


1032
1033
1034
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1032

def source_name
  @source_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1039
1040
1041
1042
1043
1044
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 1039

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