Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class SearchRequest.CrowdingSpec (0.81.0)

public static final class SearchRequest.CrowdingSpec extends GeneratedMessage 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

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

Implements

SearchRequest.CrowdingSpecOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER

Field Value
Type	Description
`int`

MAX_COUNT_FIELD_NUMBER

public static final int MAX_COUNT_FIELD_NUMBER

Field Value
Type	Description
`int`

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SearchRequest.CrowdingSpec getDefaultInstance()

Returns
Type	Description
`SearchRequest.CrowdingSpec`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SearchRequest.CrowdingSpec.Builder newBuilder()

Returns
Type	Description
`SearchRequest.CrowdingSpec.Builder`

newBuilder(SearchRequest.CrowdingSpec prototype)

public static SearchRequest.CrowdingSpec.Builder newBuilder(SearchRequest.CrowdingSpec prototype)

Parameter
Name	Description
`prototype`	`SearchRequest.CrowdingSpec`

Returns
Type	Description
`SearchRequest.CrowdingSpec.Builder`

parseDelimitedFrom(InputStream input)

public static SearchRequest.CrowdingSpec parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.CrowdingSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SearchRequest.CrowdingSpec parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.CrowdingSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SearchRequest.CrowdingSpec parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.CrowdingSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SearchRequest.CrowdingSpec parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.CrowdingSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SearchRequest.CrowdingSpec parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.CrowdingSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SearchRequest.CrowdingSpec parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.CrowdingSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SearchRequest.CrowdingSpec`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SearchRequest.CrowdingSpec> parser()

Returns
Type	Description
`Parser<CrowdingSpec>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchRequest.CrowdingSpec getDefaultInstanceForType()

Returns
Type	Description
`SearchRequest.CrowdingSpec`

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.

getParserForType()

public Parser<SearchRequest.CrowdingSpec> getParserForType()

Returns
Type	Description
`Parser<CrowdingSpec>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchRequest.CrowdingSpec.Builder newBuilderForType()

Returns
Type	Description
`SearchRequest.CrowdingSpec.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchRequest.CrowdingSpec.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`SearchRequest.CrowdingSpec.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SearchRequest.CrowdingSpec.Builder toBuilder()

Returns
Type	Description
`SearchRequest.CrowdingSpec.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`