Package com.google.cloud.discoveryengine.v1

Interface SearchRequest.CrowdingSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchRequest.CrowdingSpec, SearchRequest.CrowdingSpec.Builder
Enclosing class:
SearchRequest
public static interface SearchRequest.CrowdingSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getField()
    The field to use for crowding.
    com.google.protobuf.ByteString
    getFieldBytes()
    The field to use for crowding.
    int
    getMaxCount()
    The maximum number of documents to keep per value of the field.
    SearchRequest.CrowdingSpec.Mode
    getMode()
    Mode to use for documents that are crowded away.
    int
    getModeValue()
    Mode to use for documents that are crowded away.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getField

      String getField()
       The field to use for crowding. Documents can be crowded by a field in the
 [Document][google.cloud.discoveryengine.v1.Document] object. Crowding
 field is case sensitive.
      string field = 1;
      Returns:
      The field.

    • getFieldBytes

      com.google.protobuf.ByteString getFieldBytes()
       The field to use for crowding. Documents can be crowded by a field in the
 [Document][google.cloud.discoveryengine.v1.Document] object. Crowding
 field is case sensitive.
      string field = 1;
      Returns:
      The bytes for field.

    • getMaxCount

      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:
      The maxCount.

    • getModeValue

      int getModeValue()
       Mode to use for documents that are crowded away.
      .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;
      Returns:
      The enum numeric value on the wire for mode.

    • getMode

      SearchRequest.CrowdingSpec.Mode getMode()
       Mode to use for documents that are crowded away.
      .google.cloud.discoveryengine.v1.SearchRequest.CrowdingSpec.Mode mode = 3;
      Returns:
      The mode.