public interface SearchInfoOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getOffset()
public abstract int getOffset()
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.
optional int32 offset = 3;
Returns | |
---|---|
Type | Description |
int |
The offset. |
getOrderBy()
public abstract String getOrderBy()
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.
string order_by = 2;
Returns | |
---|---|
Type | Description |
String |
The orderBy. |
getOrderByBytes()
public abstract ByteString getOrderByBytes()
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.
string order_by = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for orderBy. |
getSearchQuery()
public abstract String getSearchQuery()
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.
string search_query = 1;
Returns | |
---|---|
Type | Description |
String |
The searchQuery. |
getSearchQueryBytes()
public abstract ByteString getSearchQueryBytes()
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.
string search_query = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for searchQuery. |
hasOffset()
public abstract boolean hasOffset()
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.
optional int32 offset = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the offset field is set. |