Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::SearchRequest::FacetSpec::FacetKey

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/search_service.rb

Overview

Specifies how a facet is computed.

Instance Attribute Summary

• #case_insensitive ⇒ ::Boolean

  True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.

• #contains ⇒ ::Array<::String>

  Only get facet values that contain the given strings.

• #intervals ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Interval>

  Set only if values should be bucketed into intervals.

• #key ⇒ ::String

  Required.

• #order_by ⇒ ::String

  The order in which documents are returned.

• #prefixes ⇒ ::Array<::String>

  Only get facet values that start with the given string prefix.

• #restricted_values ⇒ ::Array<::String>

  Only get facet for the given restricted values.

Instance Attribute Details

#case_insensitive ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#contains ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#intervals ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Interval>

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#key ⇒ ::String

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#order_by ⇒ ::String

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#prefixes ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#restricted_values ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 549

class FacetKey
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end