Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

A facet result.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchResponseFacet

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchResponseFacet.



5952
5953
5954
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5952

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

Instance Attribute Details

#dynamic_facetBoolean Also known as: dynamic_facet?

Whether the facet is dynamically generated. Corresponds to the JSON property dynamicFacet

Returns:

  • (Boolean)


5938
5939
5940
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5938

def dynamic_facet
  @dynamic_facet
end

#keyString

The key for this facet. E.g., "colors" or "price". It matches SearchRequest. FacetSpec.FacetKey.key. Corresponds to the JSON property key

Returns:

  • (String)


5945
5946
5947
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5945

def key
  @key
end

#valuesArray<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue>

The facet values for this field. Corresponds to the JSON property values



5950
5951
5952
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5950

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5957
5958
5959
5960
5961
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5957

def update!(**args)
  @dynamic_facet = args[:dynamic_facet] if args.key?(:dynamic_facet)
  @key = args[:key] if args.key?(:key)
  @values = args[:values] if args.key?(:values)
end