com.yelp.nrtsearch.server.grpc.FieldOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of clientlib Show documentation
Show all versions of clientlib Show documentation
GRPC Clientlib for nrtSearch
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yelp/nrtsearch/luceneserver.proto
// Protobuf Java Version: 3.25.3
package com.yelp.nrtsearch.server.grpc;
public interface FieldOrBuilder extends
// @@protoc_insertion_point(interface_extends:luceneserver.Field)
com.google.protobuf.MessageOrBuilder {
/**
*
* name of the field
*
*
* string name = 1;
* @return The name.
*/
java.lang.String getName();
/**
*
* name of the field
*
*
* string name = 1;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
* .luceneserver.FieldType type = 2;
* @return The enum numeric value on the wire for type.
*/
int getTypeValue();
/**
* .luceneserver.FieldType type = 2;
* @return The type.
*/
com.yelp.nrtsearch.server.grpc.FieldType getType();
/**
*
* True if the value should be available for searching (or numeric range searching, for a numeric field).
*
*
* bool search = 3;
* @return The search.
*/
boolean getSearch();
/**
*
* True if the value should be stored.
*
*
* bool store = 4;
* @return The store.
*/
boolean getStore();
/**
*
* Whether to index the value into doc values.
*
*
* bool storeDocValues = 5;
* @return The storeDocValues.
*/
boolean getStoreDocValues();
/**
*
* True if the value should be indexed into doc values for sorting.
*
*
* bool sort = 6 [deprecated = true];
* @deprecated luceneserver.Field.sort is deprecated.
* See yelp/nrtsearch/luceneserver.proto;l=530
* @return The sort.
*/
@java.lang.Deprecated boolean getSort();
/**
*
* This is now determined from the field type
*
*
* bool tokenize = 7 [deprecated = true];
* @deprecated luceneserver.Field.tokenize is deprecated.
* See yelp/nrtsearch/luceneserver.proto;l=531
* @return The tokenize.
*/
@java.lang.Deprecated boolean getTokenize();
/**
*
* True if the value should be indexed into doc values for grouping.
*
*
* bool group = 8 [deprecated = true];
* @deprecated luceneserver.Field.group is deprecated.
* See yelp/nrtsearch/luceneserver.proto;l=532
* @return The group.
*/
@java.lang.Deprecated boolean getGroup();
/**
*
* True if this field may sometimes have more than one value.
*
*
* bool multiValued = 9;
* @return The multiValued.
*/
boolean getMultiValued();
/**
*
* This parameter would be ignored
*
*
* bool highlight = 10 [deprecated = true];
* @deprecated luceneserver.Field.highlight is deprecated.
* See yelp/nrtsearch/luceneserver.proto;l=534
* @return The highlight.
*/
@java.lang.Deprecated boolean getHighlight();
/**
*
* True if norms are omitted.
*
*
* bool omitNorms = 11;
* @return The omitNorms.
*/
boolean getOmitNorms();
/**
*
* Format string used to parse datetime fields, supported values are: 1) DateTimeFormatter format 2) "epoch_millis" (datetime value is epoch timestamp) 3) "strict_date_optional_time" (date with optional time in pattern of "yyyy-MM-dd['T'HH:mm:ss[.SSS]]")
*
*
* string dateTimeFormat = 12;
* @return The dateTimeFormat.
*/
java.lang.String getDateTimeFormat();
/**
*
* Format string used to parse datetime fields, supported values are: 1) DateTimeFormatter format 2) "epoch_millis" (datetime value is epoch timestamp) 3) "strict_date_optional_time" (date with optional time in pattern of "yyyy-MM-dd['T'HH:mm:ss[.SSS]]")
*
*
* string dateTimeFormat = 12;
* @return The bytes for dateTimeFormat.
*/
com.google.protobuf.ByteString
getDateTimeFormatBytes();
/**
*
* Which PostingsFormat should be used to index this field.
*
*
* string postingsFormat = 13;
* @return The postingsFormat.
*/
java.lang.String getPostingsFormat();
/**
*
* Which PostingsFormat should be used to index this field.
*
*
* string postingsFormat = 13;
* @return The bytes for postingsFormat.
*/
com.google.protobuf.ByteString
getPostingsFormatBytes();
/**
*
* Which DocValuesFormat should be used to index this field.
*
*
* string docValuesFormat = 14;
* @return The docValuesFormat.
*/
java.lang.String getDocValuesFormat();
/**
*
* Which DocValuesFormat should be used to index this field.
*
*
* string docValuesFormat = 14;
* @return The bytes for docValuesFormat.
*/
com.google.protobuf.ByteString
getDocValuesFormatBytes();
/**
*
*How the tokens should be indexed.
*
*
* .luceneserver.IndexOptions indexOptions = 15;
* @return The enum numeric value on the wire for indexOptions.
*/
int getIndexOptionsValue();
/**
*
*How the tokens should be indexed.
*
*
* .luceneserver.IndexOptions indexOptions = 15;
* @return The indexOptions.
*/
com.yelp.nrtsearch.server.grpc.IndexOptions getIndexOptions();
/**
*
* The script definition defining a virtual field's value (only used with type=virtual).
*
*
* .luceneserver.Script script = 16;
* @return Whether the script field is set.
*/
boolean hasScript();
/**
*
* The script definition defining a virtual field's value (only used with type=virtual).
*
*
* .luceneserver.Script script = 16;
* @return The script.
*/
com.yelp.nrtsearch.server.grpc.Script getScript();
/**
*
* The script definition defining a virtual field's value (only used with type=virtual).
*
*
* .luceneserver.Script script = 16;
*/
com.yelp.nrtsearch.server.grpc.ScriptOrBuilder getScriptOrBuilder();
/**
*
*TODO make analyzers message types i.e. StandardAnalyzer, EnglishAnalyzer, CustomAnalyzer etc
*
*
* .luceneserver.Analyzer analyzer = 17;
* @return Whether the analyzer field is set.
*/
boolean hasAnalyzer();
/**
*
*TODO make analyzers message types i.e. StandardAnalyzer, EnglishAnalyzer, CustomAnalyzer etc
*
*
* .luceneserver.Analyzer analyzer = 17;
* @return The analyzer.
*/
com.yelp.nrtsearch.server.grpc.Analyzer getAnalyzer();
/**
*
*TODO make analyzers message types i.e. StandardAnalyzer, EnglishAnalyzer, CustomAnalyzer etc
*
*
* .luceneserver.Analyzer analyzer = 17;
*/
com.yelp.nrtsearch.server.grpc.AnalyzerOrBuilder getAnalyzerOrBuilder();
/**
*
* Analyzer to use for this field during indexing.
*
*
* .luceneserver.Analyzer indexAnalyzer = 18;
* @return Whether the indexAnalyzer field is set.
*/
boolean hasIndexAnalyzer();
/**
*
* Analyzer to use for this field during indexing.
*
*
* .luceneserver.Analyzer indexAnalyzer = 18;
* @return The indexAnalyzer.
*/
com.yelp.nrtsearch.server.grpc.Analyzer getIndexAnalyzer();
/**
*
* Analyzer to use for this field during indexing.
*
*
* .luceneserver.Analyzer indexAnalyzer = 18;
*/
com.yelp.nrtsearch.server.grpc.AnalyzerOrBuilder getIndexAnalyzerOrBuilder();
/**
*
*Analyzer to use for this field during searching.
*
*
* .luceneserver.Analyzer searchAnalyzer = 19;
* @return Whether the searchAnalyzer field is set.
*/
boolean hasSearchAnalyzer();
/**
*
*Analyzer to use for this field during searching.
*
*
* .luceneserver.Analyzer searchAnalyzer = 19;
* @return The searchAnalyzer.
*/
com.yelp.nrtsearch.server.grpc.Analyzer getSearchAnalyzer();
/**
*
*Analyzer to use for this field during searching.
*
*
* .luceneserver.Analyzer searchAnalyzer = 19;
*/
com.yelp.nrtsearch.server.grpc.AnalyzerOrBuilder getSearchAnalyzerOrBuilder();
/**
*
* Whether/how term vectors should be indexed.
*
*
* .luceneserver.TermVectors termVectors = 20;
* @return The enum numeric value on the wire for termVectors.
*/
int getTermVectorsValue();
/**
*
* Whether/how term vectors should be indexed.
*
*
* .luceneserver.TermVectors termVectors = 20;
* @return The termVectors.
*/
com.yelp.nrtsearch.server.grpc.TermVectors getTermVectors();
/**
*
*TODO make similarity message types i.d. DefaultSimilarity, CustomSimilarity, BM25Similarity;
*
*
* string similarity = 21;
* @return The similarity.
*/
java.lang.String getSimilarity();
/**
*
*TODO make similarity message types i.d. DefaultSimilarity, CustomSimilarity, BM25Similarity;
*
*
* string similarity = 21;
* @return The bytes for similarity.
*/
com.google.protobuf.ByteString
getSimilarityBytes();
/**
*
* Whether this field should index facets, and how.
*
*
* .luceneserver.FacetType facet = 22;
* @return The enum numeric value on the wire for facet.
*/
int getFacetValue();
/**
*
* Whether this field should index facets, and how.
*
*
* .luceneserver.FacetType facet = 22;
* @return The facet.
*/
com.yelp.nrtsearch.server.grpc.FacetType getFacet();
/**
*
* "Which underlying Lucene index field is used to hold any indexed taxonomy or sorted set doc values facets
*
*
* string facetIndexFieldName = 23;
* @return The facetIndexFieldName.
*/
java.lang.String getFacetIndexFieldName();
/**
*
* "Which underlying Lucene index field is used to hold any indexed taxonomy or sorted set doc values facets
*
*
* string facetIndexFieldName = 23;
* @return The bytes for facetIndexFieldName.
*/
com.google.protobuf.ByteString
getFacetIndexFieldNameBytes();
/**
*
* Additional info needed to configure field, used for CUSTOM types.
*
*
* .google.protobuf.Struct additionalProperties = 24;
* @return Whether the additionalProperties field is set.
*/
boolean hasAdditionalProperties();
/**
*
* Additional info needed to configure field, used for CUSTOM types.
*
*
* .google.protobuf.Struct additionalProperties = 24;
* @return The additionalProperties.
*/
com.google.protobuf.Struct getAdditionalProperties();
/**
*
* Additional info needed to configure field, used for CUSTOM types.
*
*
* .google.protobuf.Struct additionalProperties = 24;
*/
com.google.protobuf.StructOrBuilder getAdditionalPropertiesOrBuilder();
/**
*
* Parameters for similarity implementation.
*
*
* .google.protobuf.Struct similarityParams = 25;
* @return Whether the similarityParams field is set.
*/
boolean hasSimilarityParams();
/**
*
* Parameters for similarity implementation.
*
*
* .google.protobuf.Struct similarityParams = 25;
* @return The similarityParams.
*/
com.google.protobuf.Struct getSimilarityParams();
/**
*
* Parameters for similarity implementation.
*
*
* .google.protobuf.Struct similarityParams = 25;
*/
com.google.protobuf.StructOrBuilder getSimilarityParamsOrBuilder();
/**
*
* Child fields accessible by dot notation, index same data as parent
*
*
* repeated .luceneserver.Field childFields = 26;
*/
java.util.List
getChildFieldsList();
/**
*
* Child fields accessible by dot notation, index same data as parent
*
*
* repeated .luceneserver.Field childFields = 26;
*/
com.yelp.nrtsearch.server.grpc.Field getChildFields(int index);
/**
*
* Child fields accessible by dot notation, index same data as parent
*
*
* repeated .luceneserver.Field childFields = 26;
*/
int getChildFieldsCount();
/**
*
* Child fields accessible by dot notation, index same data as parent
*
*
* repeated .luceneserver.Field childFields = 26;
*/
java.util.List
getChildFieldsOrBuilderList();
/**
*
* Child fields accessible by dot notation, index same data as parent
*
*
* repeated .luceneserver.Field childFields = 26;
*/
com.yelp.nrtsearch.server.grpc.FieldOrBuilder getChildFieldsOrBuilder(
int index);
/**
*
* Compute facet global ordinals for this field up front, otherwise this is done lazily on first query. Currently only for SORTED_SET_DOC_VALUES facet type.
*
*
* bool eagerGlobalOrdinals = 27;
* @return The eagerGlobalOrdinals.
*/
boolean getEagerGlobalOrdinals();
/**
*
* True if object data should be indexed as child documents
*
*
* bool nestedDoc = 28;
* @return The nestedDoc.
*/
boolean getNestedDoc();
/**
*
* Dimensions for vector field type
*
*
* int32 vectorDimensions = 29;
* @return The vectorDimensions.
*/
int getVectorDimensions();
/**
*
* If field based global ordinals should be built up front, otherwise this is done lazily on first access. Currently only for fields with text doc values (TEXT/ATOM).
*
*
* bool eagerFieldGlobalOrdinals = 30;
* @return The eagerFieldGlobalOrdinals.
*/
boolean getEagerFieldGlobalOrdinals();
/**
*
* Similarity type for search enabled VECTOR fields. This is a required option when search=true.
* Accepts built in types:
* 'l2_norm' : (1 / (1 + l2_norm(query, vector)^2))
* 'dot_product' : Float vector: ((1 + dot_product(query, vector)) / 2) (all vectors must be unit length)
* Byte vector : 0.5 + (dot_product(query, vector) / (32768 * dims)) (all vectors must have the same length)
* 'cosine' : ((1 + cosine(query, vector)) / 2)
* 'max_inner_product': when < 0 : 1 / (1 + -1 * max_inner_product(query, vector))
* when >= 0: max_inner_product(query, vector) + 1
*
*
* string vectorSimilarity = 31;
* @return The vectorSimilarity.
*/
java.lang.String getVectorSimilarity();
/**
*
* Similarity type for search enabled VECTOR fields. This is a required option when search=true.
* Accepts built in types:
* 'l2_norm' : (1 / (1 + l2_norm(query, vector)^2))
* 'dot_product' : Float vector: ((1 + dot_product(query, vector)) / 2) (all vectors must be unit length)
* Byte vector : 0.5 + (dot_product(query, vector) / (32768 * dims)) (all vectors must have the same length)
* 'cosine' : ((1 + cosine(query, vector)) / 2)
* 'max_inner_product': when < 0 : 1 / (1 + -1 * max_inner_product(query, vector))
* when >= 0: max_inner_product(query, vector) + 1
*
*
* string vectorSimilarity = 31;
* @return The bytes for vectorSimilarity.
*/
com.google.protobuf.ByteString
getVectorSimilarityBytes();
/**
*
* Indexing options for search enabled VECTOR field type. This is optional, defaulting to HNSW with m=16, ef_construction=100 when not set.
*
*
* .luceneserver.VectorIndexingOptions vectorIndexingOptions = 32;
* @return Whether the vectorIndexingOptions field is set.
*/
boolean hasVectorIndexingOptions();
/**
*
* Indexing options for search enabled VECTOR field type. This is optional, defaulting to HNSW with m=16, ef_construction=100 when not set.
*
*
* .luceneserver.VectorIndexingOptions vectorIndexingOptions = 32;
* @return The vectorIndexingOptions.
*/
com.yelp.nrtsearch.server.grpc.VectorIndexingOptions getVectorIndexingOptions();
/**
*
* Indexing options for search enabled VECTOR field type. This is optional, defaulting to HNSW with m=16, ef_construction=100 when not set.
*
*
* .luceneserver.VectorIndexingOptions vectorIndexingOptions = 32;
*/
com.yelp.nrtsearch.server.grpc.VectorIndexingOptionsOrBuilder getVectorIndexingOptionsOrBuilder();
/**
*
* Specify docvalues type for TEXT/ATOM field types. This is optional, defaulting to SORTED when not set. Multivalued fields will always use SORTED_SET.
*
*
* .luceneserver.TextDocValuesType textDocValuesType = 33;
* @return The enum numeric value on the wire for textDocValuesType.
*/
int getTextDocValuesTypeValue();
/**
*
* Specify docvalues type for TEXT/ATOM field types. This is optional, defaulting to SORTED when not set. Multivalued fields will always use SORTED_SET.
*
*
* .luceneserver.TextDocValuesType textDocValuesType = 33;
* @return The textDocValuesType.
*/
com.yelp.nrtsearch.server.grpc.TextDocValuesType getTextDocValuesType();
/**
*
* Element type for vector field, defaulting to FLOAT when not set.
*
*
* .luceneserver.VectorElementType vectorElementType = 34;
* @return The enum numeric value on the wire for vectorElementType.
*/
int getVectorElementTypeValue();
/**
*
* Element type for vector field, defaulting to FLOAT when not set.
*
*
* .luceneserver.VectorElementType vectorElementType = 34;
* @return The vectorElementType.
*/
com.yelp.nrtsearch.server.grpc.VectorElementType getVectorElementType();
/**
*
* Position increment gap for indexing multi valued TEXT fields. Must be >= 0, defaulting to 100 when not set.
*
*
* optional int32 positionIncrementGap = 35;
* @return Whether the positionIncrementGap field is set.
*/
boolean hasPositionIncrementGap();
/**
*
* Position increment gap for indexing multi valued TEXT fields. Must be >= 0, defaulting to 100 when not set.
*
*
* optional int32 positionIncrementGap = 35;
* @return The positionIncrementGap.
*/
int getPositionIncrementGap();
/**
*
* For arrays of strings, ignoreAbove will be applied for each array element separately and string elements longer than ignore_above will not be indexed or stored.
* This option is also useful for protecting against Lucene’s term byte-length limit of 32766
*
*
* optional int32 ignoreAbove = 36;
* @return Whether the ignoreAbove field is set.
*/
boolean hasIgnoreAbove();
/**
*
* For arrays of strings, ignoreAbove will be applied for each array element separately and string elements longer than ignore_above will not be indexed or stored.
* This option is also useful for protecting against Lucene’s term byte-length limit of 32766
*
*
* optional int32 ignoreAbove = 36;
* @return The ignoreAbove.
*/
int getIgnoreAbove();
}