com.google.cloud.discoveryengine.v1beta

Interface SearchInfoOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchInfo, SearchInfo.Builder

public interface SearchInfoOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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).
String	getOrderBy() The order in which products are returned, if applicable.
com.google.protobuf.ByteString	getOrderByBytes() The order in which products are returned, if applicable.
String	getSearchQuery() The user's search query.
com.google.protobuf.ByteString	getSearchQueryBytes() The user's search query.
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).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSearchQuery

String getSearchQuery()

 The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.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:

The searchQuery.

getSearchQueryBytes

com.google.protobuf.ByteString getSearchQueryBytes()

 The user's search query.

 See
 [SearchRequest.query][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.SearchInfo.search_query]
 or
 [PageInfo.page_category][google.cloud.discoveryengine.v1beta.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:

The bytes for searchQuery.

getOrderBy

String getOrderBy()

 The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.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:

The orderBy.

getOrderByBytes

com.google.protobuf.ByteString getOrderByBytes()

 The order in which products are returned, if applicable.

 See
 [SearchRequest.order_by][google.cloud.discoveryengine.v1beta.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:

The bytes for orderBy.

hasOffset

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][google.cloud.discoveryengine.v1beta.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:

Whether the offset field is set.

getOffset

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][google.cloud.discoveryengine.v1beta.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:

The offset.