com.aerospike.vector.client.proto.IndexDefinitionOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of avs-client-java Show documentation
This project includes the Java client for Aerospike Vector Search for high-performance data interactions.
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: types.proto

// Protobuf Java Version: 3.25.5
package com.aerospike.vector.client.proto;

public interface IndexDefinitionOrBuilder extends
    // @@protoc_insertion_point(interface_extends:aerospike.vector.IndexDefinition)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The index identifier.
   * 
   *
   * .aerospike.vector.IndexId id = 1;
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * The index identifier.
   * 
   *
   * .aerospike.vector.IndexId id = 1;
   * @return The id.
   */
  com.aerospike.vector.client.proto.IndexId getId();
  /**
   *    * The index identifier.
   * 
   *
   * .aerospike.vector.IndexId id = 1;
   */
  com.aerospike.vector.client.proto.IndexIdOrBuilder getIdOrBuilder();

  /**
   *    * The type of index. Defaults to HNSW.
   * 
   *
   * optional .aerospike.vector.IndexType type = 2;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * The type of index. Defaults to HNSW.
   * 
   *
   * optional .aerospike.vector.IndexType type = 2;
   * @return The enum numeric value on the wire for type.
   */
  int getTypeValue();
  /**
   *    * The type of index. Defaults to HNSW.
   * 
   *
   * optional .aerospike.vector.IndexType type = 2;
   * @return The type.
   */
  com.aerospike.vector.client.proto.IndexType getType();

  /**
   *    * Number of dimensions in data.
   * Vectors not matching the dimension count will not be indexed.
   * 
   *
   * uint32 dimensions = 3;
   * @return The dimensions.
   */
  int getDimensions();

  /**
   *    * Optional The distance metric to use. Defaults to SQUARED_EUCLIDEAN.
   * 
   *
   * optional .aerospike.vector.VectorDistanceMetric vectorDistanceMetric = 4;
   * @return Whether the vectorDistanceMetric field is set.
   */
  boolean hasVectorDistanceMetric();
  /**
   *    * Optional The distance metric to use. Defaults to SQUARED_EUCLIDEAN.
   * 
   *
   * optional .aerospike.vector.VectorDistanceMetric vectorDistanceMetric = 4;
   * @return The enum numeric value on the wire for vectorDistanceMetric.
   */
  int getVectorDistanceMetricValue();
  /**
   *    * Optional The distance metric to use. Defaults to SQUARED_EUCLIDEAN.
   * 
   *
   * optional .aerospike.vector.VectorDistanceMetric vectorDistanceMetric = 4;
   * @return The vectorDistanceMetric.
   */
  com.aerospike.vector.client.proto.VectorDistanceMetric getVectorDistanceMetric();

  /**
   *    * Name of the record vector field to index.
   * 
   *
   * string field = 5;
   * @return The field.
   */
  java.lang.String getField();
  /**
   *    * Name of the record vector field to index.
   * 
   *
   * string field = 5;
   * @return The bytes for field.
   */
  com.google.protobuf.ByteString
      getFieldBytes();

  /**
   *    * Optional filter on Aerospike set name from which records will be indexed.
   * If not specified all sets in the index namespace will be indexed.
   * 
   *
   * optional string setFilter = 6;
   * @return Whether the setFilter field is set.
   */
  boolean hasSetFilter();
  /**
   *    * Optional filter on Aerospike set name from which records will be indexed.
   * If not specified all sets in the index namespace will be indexed.
   * 
   *
   * optional string setFilter = 6;
   * @return The setFilter.
   */
  java.lang.String getSetFilter();
  /**
   *    * Optional filter on Aerospike set name from which records will be indexed.
   * If not specified all sets in the index namespace will be indexed.
   * 
   *
   * optional string setFilter = 6;
   * @return The bytes for setFilter.
   */
  com.google.protobuf.ByteString
      getSetFilterBytes();

  /**
   * .aerospike.vector.HnswParams hnswParams = 7;
   * @return Whether the hnswParams field is set.
   */
  boolean hasHnswParams();
  /**
   * .aerospike.vector.HnswParams hnswParams = 7;
   * @return The hnswParams.
   */
  com.aerospike.vector.client.proto.HnswParams getHnswParams();
  /**
   * .aerospike.vector.HnswParams hnswParams = 7;
   */
  com.aerospike.vector.client.proto.HnswParamsOrBuilder getHnswParamsOrBuilder();

  /**
   *    * Optional labels associated with the index.
   * 
   *
   * map<string, string> labels = 8;
   */
  int getLabelsCount();
  /**
   *    * Optional labels associated with the index.
   * 
   *
   * map<string, string> labels = 8;
   */
  boolean containsLabels(
      java.lang.String key);
  /**
   * Use {@link #getLabelsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getLabels();
  /**
   *    * Optional labels associated with the index.
   * 
   *
   * map<string, string> labels = 8;
   */
  java.util.Map
  getLabelsMap();
  /**
   *    * Optional labels associated with the index.
   * 
   *
   * map<string, string> labels = 8;
   */
  /* nullable */
java.lang.String getLabelsOrDefault(
      java.lang.String key,
      /* nullable */
java.lang.String defaultValue);
  /**
   *    * Optional labels associated with the index.
   * 
   *
   * map<string, string> labels = 8;
   */
  java.lang.String getLabelsOrThrow(
      java.lang.String key);

  /**
   *    * Index storage.
   * 
   *
   * optional .aerospike.vector.IndexStorage storage = 9;
   * @return Whether the storage field is set.
   */
  boolean hasStorage();
  /**
   *    * Index storage.
   * 
   *
   * optional .aerospike.vector.IndexStorage storage = 9;
   * @return The storage.
   */
  com.aerospike.vector.client.proto.IndexStorage getStorage();
  /**
   *    * Index storage.
   * 
   *
   * optional .aerospike.vector.IndexStorage storage = 9;
   */
  com.aerospike.vector.client.proto.IndexStorageOrBuilder getStorageOrBuilder();

  com.aerospike.vector.client.proto.IndexDefinition.ParamsCase getParamsCase();
}