Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchInfo
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchInfo
- 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
Detailed search information.
Instance Attribute Summary collapse
-
#offset ⇒ Fixnum
An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).
-
#order_by ⇒ String
The order in which products are returned, if applicable.
-
#search_query ⇒ String
The user's search query.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchInfo
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaSearchInfo.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchInfo
Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchInfo.
5236 5237 5238 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5236 def initialize(**args) update!(**args) end |
Instance Attribute Details
#offset ⇒ Fixnum
An integer that specifies the current offset for pagination (the 0-indexed
starting location, amongst the products deemed by the API as relevant). See
SearchRequest.offset for definition. If this field is negative, an
INVALID_ARGUMENT
is returned. This can only be set for search
events. Other
event types should not set this field. Otherwise, an INVALID_ARGUMENT
error
is returned.
Corresponds to the JSON property offset
5215 5216 5217 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5215 def offset @offset end |
#order_by ⇒ String
The order in which products are returned, if applicable. See SearchRequest.
order_by for definition and syntax. The value must be a UTF-8 encoded string
with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT
error is returned. This can only be set for search
events. Other event types
should not set this field. Otherwise, an INVALID_ARGUMENT
error is returned.
Corresponds to the JSON property orderBy
5224 5225 5226 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5224 def order_by @order_by end |
#search_query ⇒ String
The user's search query. See SearchRequest.query for definition. The value
must be a UTF-8 encoded string with a length limit of 5,000 characters.
Otherwise, an INVALID_ARGUMENT
error is returned. At least one of
search_query or PageInfo.page_category is required for search
events. Other
event types should not set this field. Otherwise, an INVALID_ARGUMENT
error
is returned.
Corresponds to the JSON property searchQuery
5234 5235 5236 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5234 def search_query @search_query end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5241 5242 5243 5244 5245 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 5241 def update!(**args) @offset = args[:offset] if args.key?(:offset) @order_by = args[:order_by] if args.key?(:order_by) @search_query = args[:search_query] if args.key?(:search_query) end |