Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::SearchInfo (v1.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::SearchInfo.

Detailed search information.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#offset

def offset() -> ::Integer
Returns
  • (::Integer) — 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.

#offset=

def offset=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.

Returns
  • (::Integer) — 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.

#order_by

def order_by() -> ::String
Returns
  • (::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.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#search_query

def search_query() -> ::String
Returns
  • (::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.

#search_query=

def search_query=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.