Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchInfo

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

Detailed search information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchInfo

Returns a new instance of GoogleCloudDiscoveryengineV1SearchInfo.



7053
7054
7055
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7053

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) 


7032
7033
7034
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7032

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) 


7041
7042
7043
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7041

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

Returns:

  • (String) 


7051
7052
7053
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7051

def search_query
  @search_query
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7058
7059
7060
7061
7062
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 7058

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