public static final class SearchInfo.Builder extends GeneratedMessageV3.Builder<SearchInfo.Builder> implements SearchInfoOrBuilderDetailed search information.
Protobuf type google.cloud.discoveryengine.v1beta.SearchInfo
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchInfo.BuilderImplements
SearchInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SearchInfo.Builder |
build()
public SearchInfo build()| Type | Description |
| SearchInfo |
buildPartial()
public SearchInfo buildPartial()| Type | Description |
| SearchInfo |
clear()
public SearchInfo.Builder clear()| Type | Description |
| SearchInfo.Builder |
clearField(Descriptors.FieldDescriptor field)
public SearchInfo.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| SearchInfo.Builder |
clearOffset()
public SearchInfo.Builder clearOffset() 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 |
| SearchInfo.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| SearchInfo.Builder |
clearOrderBy()
public SearchInfo.Builder clearOrderBy() 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 |
| SearchInfo.Builder | This builder for chaining. |
clearSearchQuery()
public SearchInfo.Builder clearSearchQuery() 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 |
| SearchInfo.Builder | This builder for chaining. |
clone()
public SearchInfo.Builder clone()| Type | Description |
| SearchInfo.Builder |
getDefaultInstanceForType()
public SearchInfo getDefaultInstanceForType()| Type | Description |
| SearchInfo |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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. |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(SearchInfo other)
public SearchInfo.Builder mergeFrom(SearchInfo other)| Name | Description |
| other | SearchInfo |
| Type | Description |
| SearchInfo.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| SearchInfo.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public SearchInfo.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| SearchInfo.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SearchInfo.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| SearchInfo.Builder |
setOffset(int value)
public SearchInfo.Builder setOffset(int value) 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;
| Name | Description |
| value | intThe offset to set. |
| Type | Description |
| SearchInfo.Builder | This builder for chaining. |
setOrderBy(String value)
public SearchInfo.Builder setOrderBy(String value) 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;
| Name | Description |
| value | StringThe orderBy to set. |
| Type | Description |
| SearchInfo.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public SearchInfo.Builder setOrderByBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for orderBy to set. |
| Type | Description |
| SearchInfo.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| SearchInfo.Builder |
setSearchQuery(String value)
public SearchInfo.Builder setSearchQuery(String value) 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;
| Name | Description |
| value | StringThe searchQuery to set. |
| Type | Description |
| SearchInfo.Builder | This builder for chaining. |
setSearchQueryBytes(ByteString value)
public SearchInfo.Builder setSearchQueryBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for searchQuery to set. |
| Type | Description |
| SearchInfo.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| SearchInfo.Builder |