Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchInfo

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchInfo

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchInfo.



1189
1190
1191
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1189

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

Returns:

  • (Fixnum) 


1169
1170
1171
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1169

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

Returns:

  • (String) 


1178
1179
1180
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1178

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 page_categories 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

Returns:

  • (String) 


1187
1188
1189
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1187

def search_query
  @search_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1194
1195
1196
1197
1198
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1194

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