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



901
902
903
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 901

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

Instance Attribute Details

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


887
888
889
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 887

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) 


893
894
895
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 893

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) 


899
900
901
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 899

def source_name
  @source_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



906
907
908
909
910
 
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 906

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