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