Class SearchResponse.QueryExpansionInfo.Builder (2.48.0)

public static final class SearchResponse.QueryExpansionInfo.Builder extends GeneratedMessageV3.Builder<SearchResponse.QueryExpansionInfo.Builder> implements SearchResponse.QueryExpansionInfoOrBuilder

Information describing query expansion including whether expansion has occurred.

Protobuf type google.cloud.retail.v2.SearchResponse.QueryExpansionInfo

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.QueryExpansionInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

build()

public SearchResponse.QueryExpansionInfo build()
Returns
Type Description
SearchResponse.QueryExpansionInfo

buildPartial()

public SearchResponse.QueryExpansionInfo buildPartial()
Returns
Type Description
SearchResponse.QueryExpansionInfo

clear()

public SearchResponse.QueryExpansionInfo.Builder clear()
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

clearExpandedQuery()

public SearchResponse.QueryExpansionInfo.Builder clearExpandedQuery()

Bool describing whether query expansion has occurred.

bool expanded_query = 1;

Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchResponse.QueryExpansionInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponse.QueryExpansionInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

clearPinnedResultCount()

public SearchResponse.QueryExpansionInfo.Builder clearPinnedResultCount()

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

int64 pinned_result_count = 2;

Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder

This builder for chaining.

clone()

public SearchResponse.QueryExpansionInfo.Builder clone()
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

getDefaultInstanceForType()

public SearchResponse.QueryExpansionInfo getDefaultInstanceForType()
Returns
Type Description
SearchResponse.QueryExpansionInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExpandedQuery()

public boolean getExpandedQuery()

Bool describing whether query expansion has occurred.

bool expanded_query = 1;

Returns
Type Description
boolean

The expandedQuery.

getPinnedResultCount()

public long getPinnedResultCount()

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

int64 pinned_result_count = 2;

Returns
Type Description
long

The pinnedResultCount.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchResponse.QueryExpansionInfo other)

public SearchResponse.QueryExpansionInfo.Builder mergeFrom(SearchResponse.QueryExpansionInfo other)
Parameter
Name Description
other SearchResponse.QueryExpansionInfo
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchResponse.QueryExpansionInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchResponse.QueryExpansionInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.QueryExpansionInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

setExpandedQuery(boolean value)

public SearchResponse.QueryExpansionInfo.Builder setExpandedQuery(boolean value)

Bool describing whether query expansion has occurred.

bool expanded_query = 1;

Parameter
Name Description
value boolean

The expandedQuery to set.

Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponse.QueryExpansionInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

setPinnedResultCount(long value)

public SearchResponse.QueryExpansionInfo.Builder setPinnedResultCount(long value)

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

int64 pinned_result_count = 2;

Parameter
Name Description
value long

The pinnedResultCount to set.

Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchResponse.QueryExpansionInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponse.QueryExpansionInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchResponse.QueryExpansionInfo.Builder
Overrides