- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public final class SearchInfo extends GeneratedMessageV3 implements SearchInfoOrBuilderDetailed search information.
Protobuf type google.cloud.discoveryengine.v1beta.SearchInfo
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchInfoImplements
SearchInfoOrBuilderStatic Fields
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER| Type | Description |
int |
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER| Type | Description |
int |
SEARCH_QUERY_FIELD_NUMBER
public static final int SEARCH_QUERY_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static SearchInfo getDefaultInstance()| Type | Description |
SearchInfo |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static SearchInfo.Builder newBuilder()| Type | Description |
SearchInfo.Builder |
newBuilder(SearchInfo prototype)
public static SearchInfo.Builder newBuilder(SearchInfo prototype)| Name | Description |
prototype | SearchInfo |
| Type | Description |
SearchInfo.Builder |
parseDelimitedFrom(InputStream input)
public static SearchInfo parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
SearchInfo |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
SearchInfo |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static SearchInfo parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
SearchInfo |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
SearchInfo |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static SearchInfo parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
SearchInfo |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
SearchInfo |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static SearchInfo parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
SearchInfo |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
SearchInfo |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static SearchInfo parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
SearchInfo |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
SearchInfo |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static SearchInfo parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
SearchInfo |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
SearchInfo |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<SearchInfo> parser()| Type | Description |
Parser<SearchInfo> |
Methods
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
getDefaultInstanceForType()
public SearchInfo getDefaultInstanceForType()| Type | Description |
SearchInfo |
getOffset()
public 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;
| 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;
| Type | Description |
ByteString | The bytes for orderBy. |
getParserForType()
public Parser<SearchInfo> getParserForType()| Type | Description |
Parser<SearchInfo> |
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()| Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
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()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public SearchInfo.Builder newBuilderForType()| Type | Description |
SearchInfo.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
SearchInfo.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public SearchInfo.Builder toBuilder()| Type | Description |
SearchInfo.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |