Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseFacet

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

Overview

A facet result.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchResponseFacet

Returns a new instance of GoogleCloudDiscoveryengineV1SearchResponseFacet.



4417
4418
4419
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4417

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

Instance Attribute Details

#dynamic_facet ⇒ Boolean Also known as: dynamic_facet?

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

Returns:

  • (Boolean) 


4403
4404
4405
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4403

def dynamic_facet
  @dynamic_facet
end

#key ⇒ String

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

Returns:

  • (String) 


4410
4411
4412
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4410

def key
  @key
end

#values ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue>

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

Returns:



4415
4416
4417
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4415

def values
  @values
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4422
4423
4424
4425
4426
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 4422

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