Class SearchInfo.Builder (0.30.0)

public static final class SearchInfo.Builder extends GeneratedMessageV3.Builder<SearchInfo.Builder> implements SearchInfoOrBuilder

Detailed search information.

Protobuf type google.cloud.discoveryengine.v1.SearchInfo

Implements

SearchInfoOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchInfo.Builder
Overrides

build()

public SearchInfo build()
Returns
TypeDescription
SearchInfo

buildPartial()

public SearchInfo buildPartial()
Returns
TypeDescription
SearchInfo

clear()

public SearchInfo.Builder clear()
Returns
TypeDescription
SearchInfo.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchInfo.Builder
Overrides

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
TypeDescription
SearchInfo.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchInfo.Builder
Overrides

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
TypeDescription
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
TypeDescription
SearchInfo.Builder

This builder for chaining.

clone()

public SearchInfo.Builder clone()
Returns
TypeDescription
SearchInfo.Builder
Overrides

getDefaultInstanceForType()

public SearchInfo getDefaultInstanceForType()
Returns
TypeDescription
SearchInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the offset field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchInfo other)

public SearchInfo.Builder mergeFrom(SearchInfo other)
Parameter
NameDescription
otherSearchInfo
Returns
TypeDescription
SearchInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchInfo.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchInfo.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchInfo.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchInfo.Builder
Overrides

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
NameDescription
valueint

The offset to set.

Returns
TypeDescription
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
NameDescription
valueString

The orderBy to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for orderBy to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchInfo.Builder
Overrides

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
NameDescription
valueString

The searchQuery to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for searchQuery to set.

Returns
TypeDescription
SearchInfo.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchInfo.Builder
Overrides