Class SearchRequest.CrowdingSpec.Builder (0.81.0)

Version latest

• 0.79.0 (latest)
• 0.78.0
• 0.77.0
• 0.76.0
• 0.74.0
• 0.72.0
• 0.71.0
• 0.70.0
• 0.69.0
• 0.68.0
• 0.66.0
• 0.64.0
• 0.63.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 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 SearchRequest.CrowdingSpec.Builder extends GeneratedMessage.Builder<SearchRequest.CrowdingSpec.Builder> implements SearchRequest.CrowdingSpecOrBuilder

Specification for crowding. Crowding improves the diversity of search results by limiting the number of results that share the same field value. For example, crowding on the color field with a max_count of 3 and mode DROP_CROWDED_RESULTS will return at most 3 results with the same color across all pages.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchRequest.CrowdingSpec.Builder

Implements

SearchRequest.CrowdingSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public SearchRequest.CrowdingSpec build()

Returns
Type	Description
SearchRequest.CrowdingSpec

buildPartial()

public SearchRequest.CrowdingSpec buildPartial()

Returns
Type	Description
SearchRequest.CrowdingSpec

clear()

public SearchRequest.CrowdingSpec.Builder clear()

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearField()

public SearchRequest.CrowdingSpec.Builder clearField()

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

string field = 1;

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

clearMaxCount()

public SearchRequest.CrowdingSpec.Builder clearMaxCount()

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in order_by), later results with the same value are "crowded away". If not specified, the default value is 1.

int32 max_count = 2;

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

clearMode()

public SearchRequest.CrowdingSpec.Builder clearMode()

Mode to use for documents that are crowded away.

.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchRequest.CrowdingSpec getDefaultInstanceForType()

Returns
Type	Description
SearchRequest.CrowdingSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getField()

public String getField()

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

string field = 1;

Returns
Type	Description
String	The field.

getFieldBytes()

public ByteString getFieldBytes()

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

string field = 1;

Returns
Type	Description
ByteString	The bytes for field.

getMaxCount()

public int getMaxCount()

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in order_by), later results with the same value are "crowded away". If not specified, the default value is 1.

int32 max_count = 2;

Returns
Type	Description
int	The maxCount.

getMode()

public SearchRequest.CrowdingSpec.Mode getMode()

Mode to use for documents that are crowded away.

.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;

Returns
Type	Description
SearchRequest.CrowdingSpec.Mode	The mode.

getModeValue()

public int getModeValue()

Mode to use for documents that are crowded away.

.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;

Returns
Type	Description
int	The enum numeric value on the wire for mode.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(SearchRequest.CrowdingSpec other)

public SearchRequest.CrowdingSpec.Builder mergeFrom(SearchRequest.CrowdingSpec other)

Parameter
Name	Description
other	SearchRequest.CrowdingSpec

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchRequest.CrowdingSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchRequest.CrowdingSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setField(String value)

public SearchRequest.CrowdingSpec.Builder setField(String value)

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

string field = 1;

Parameter
Name	Description
value	String The field to set.

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

setFieldBytes(ByteString value)

public SearchRequest.CrowdingSpec.Builder setFieldBytes(ByteString value)

The field to use for crowding. Documents can be crowded by a field in the Document object. Crowding field is case sensitive.

string field = 1;

Parameter
Name	Description
value	ByteString The bytes for field to set.

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

setMaxCount(int value)

public SearchRequest.CrowdingSpec.Builder setMaxCount(int value)

The maximum number of documents to keep per value of the field. Once there are at least max_count previous results which contain the same value for the given field (according to the order specified in order_by), later results with the same value are "crowded away". If not specified, the default value is 1.

int32 max_count = 2;

Parameter
Name	Description
value	int The maxCount to set.

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

setMode(SearchRequest.CrowdingSpec.Mode value)

public SearchRequest.CrowdingSpec.Builder setMode(SearchRequest.CrowdingSpec.Mode value)

Mode to use for documents that are crowded away.

.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;

Parameter
Name	Description
value	SearchRequest.CrowdingSpec.Mode The mode to set.

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.

setModeValue(int value)

public SearchRequest.CrowdingSpec.Builder setModeValue(int value)

Mode to use for documents that are crowded away.

.google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;

Parameter
Name	Description
value	int The enum numeric value on the wire for mode to set.

Returns
Type	Description
SearchRequest.CrowdingSpec.Builder	This builder for chaining.