Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlFilterAction

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

Specified which products may be included in results. Uses same filter as boost.

Instance Attribute Summary

• #data_store ⇒ String

  Required.

• #filter ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1ControlFilterAction constructor

  A new instance of GoogleCloudDiscoveryengineV1ControlFilterAction.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1ControlFilterAction

Returns a new instance of GoogleCloudDiscoveryengineV1ControlFilterAction.

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2869

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

Instance Attribute Details

#data_store ⇒ String

Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/ default_collection/dataStores/default_data_store Corresponds to the JSON property dataStore

Returns:

• (String)

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2860

def data_store
  @data_store
end

#filter ⇒ String

Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. Corresponds to the JSON property filter

Returns:

• (String)

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2867

def filter
  @filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 2874

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