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.



1178
1179
1180
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1178

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) 


1158
1159
1160
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1158

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) 


1164
1165
1166
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1164

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) 


1170
1171
1172
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1170

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) 


1176
1177
1178
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1176

def source_name
  @source_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1183
1184
1185
1186
1187
1188
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 1183

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