Class: Google::Cloud::DiscoveryEngine::V1::Control

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/control.rb

Overview

Defines a conditioned behavior to employ during serving. Must be attached to a [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] to be considered at serving time. Permitted actions dependent on SolutionType.

Defined Under Namespace

Classes: BoostAction, FilterAction, RedirectAction, SynonymsAction

Instance Attribute Summary collapse

Instance Attribute Details

#associated_serving_config_ids ⇒ ::Array<::String> (readonly)

Returns Output only. List of all [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] IDs this control is attached to. May take up to 10 minutes to update after changes.

Returns:

  • (::Array<::String>) —

    Output only. List of all [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig] IDs this control is attached to. May take up to 10 minutes to update after changes.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#boost_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::BoostAction

Returns Defines a boost-type control.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#conditions ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>

Returns Determines when the associated action will trigger.

Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.

Returns:

  • (::Array<::Google::Cloud::DiscoveryEngine::V1::Condition>) —

    Determines when the associated action will trigger.

    Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. Human readable name. The identifier used in UI views.

Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.

Returns:

  • (::String) —

    Required. Human readable name. The identifier used in UI views.

    Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#filter_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::FilterAction

Returns Defines a filter-type control Currently not supported by Recommendation.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*.

Returns:

  • (::String) —

    Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#redirect_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::RedirectAction

Returns Defines a redirect-type control.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#solution_type ⇒ ::Google::Cloud::DiscoveryEngine::V1::SolutionType

Returns Required. Immutable. What solution the control belongs to.

Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#synonyms_action ⇒ ::Google::Cloud::DiscoveryEngine::V1::Control::SynonymsAction

Returns Treats a group of terms as synonyms of one another.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#use_cases ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::SearchUseCase>

Returns Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

Returns:



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 138

class Control
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Adjusts order of products in returned list.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Required. Strength of the boost, which should be in [-1, 1]. Negative
  #     boost means demotion. Default is 0.0 (No-op).
  # @!attribute [rw] filter
  #   @return [::String]
  #     Required. Specifies which products to apply the boost to.
  #
  #     If no filter is provided all products will be boosted (No-op).
  #     Syntax documentation:
  #     https://cloud.google.com/retail/docs/filter-and-order
  #     Maximum length is 5000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  # @!attribute [rw] data_store
  #   @return [::String]
  #     Required. Specifies which data store's documents can be boosted by this
  #     control. Full data store name e.g.
  #     projects/123/locations/global/collections/default_collection/dataStores/default_data_store
  class BoostAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Specified which products may be included in results.
  # Uses same filter as boost.
  # @!attribute [rw] filter
  #   @return [::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.
  # @!attribute [rw] data_store
  #   @return [::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
  class FilterAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Redirects a shopper to the provided URI.
  # @!attribute [rw] redirect_uri
  #   @return [::String]
  #     Required. The URI to which the shopper will be redirected.
  #
  #     Required.
  #     URI must have length equal or less than 2000 characters.
  #     Otherwise an INVALID ARGUMENT error is thrown.
  class RedirectAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Creates a set of terms that will act as synonyms of one another.
  #
  # Example: "happy" will also be considered as "glad", "glad" will also be
  # considered as "happy".
  # @!attribute [rw] synonyms
  #   @return [::Array<::String>]
  #     Defines a set of synonyms.
  #     Can specify up to 100 synonyms.
  #     Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
  #     thrown.
  class SynonymsAction
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end