public final class SearchInfo extends GeneratedMessageV3 implements SearchInfoOrBuilder
Detailed search information.
Protobuf type google.cloud.discoveryengine.v1beta.SearchInfo
Static Fields
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
SEARCH_QUERY_FIELD_NUMBER
public static final int SEARCH_QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchInfo getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchInfo.Builder newBuilder()
Returns
newBuilder(SearchInfo prototype)
public static SearchInfo.Builder newBuilder(SearchInfo prototype)
Parameter
Returns
public static SearchInfo parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchInfo parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchInfo parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchInfo parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchInfo parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchInfo parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchInfo> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public SearchInfo getDefaultInstanceForType()
Returns
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;
| Type | Description |
int | The offset.
|
getOrderBy()
public 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;
| Type | Description |
String | The orderBy.
|
getOrderByBytes()
public 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;
getParserForType()
public Parser<SearchInfo> getParserForType()
Returns
Overrides
getSearchQuery()
public 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 [page_categories][] is required for search events. Other event types
should not set this field. Otherwise, an INVALID_ARGUMENT error is
returned.
string search_query = 1;
| Type | Description |
String | The searchQuery.
|
getSearchQueryBytes()
public 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 [page_categories][] is required for search events. Other event types
should not set this field. Otherwise, an INVALID_ARGUMENT error is
returned.
string search_query = 1;
| Type | Description |
ByteString | The bytes for searchQuery.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasOffset()
public 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;
| Type | Description |
boolean | Whether the offset field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchInfo.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchInfo.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
