public final class SearchInfo extends GeneratedMessageV3 implements SearchInfoOrBuilder
Detailed search information.
Protobuf type google.cloud.discoveryengine.v1.SearchInfo
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SEARCH_QUERY_FIELD_NUMBER
public static final int SEARCH_QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static SearchInfo getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchInfo.Builder newBuilder()
newBuilder(SearchInfo prototype)
public static SearchInfo.Builder newBuilder(SearchInfo prototype)
public static SearchInfo parseDelimitedFrom(InputStream input)
public static SearchInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchInfo parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchInfo parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(CodedInputStream input)
public static SearchInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(InputStream input)
public static SearchInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchInfo parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchInfo> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public SearchInfo getDefaultInstanceForType()
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 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 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.
|
getParserForType()
public Parser<SearchInfo> getParserForType()
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
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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
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;
| Returns |
|---|
| Type | Description |
boolean | Whether the offset field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchInfo.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public SearchInfo.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
