.avs-client-java.0.4.1.source-code.index.proto Maven / Gradle / Ivy

Go to download
syntax = "proto3";

package aerospike.vector;

option go_package = "aerospike.com/vector/protos/";
option java_package = "com.aerospike.vector.client.proto";
option java_multiple_files = true;

import "google/protobuf/empty.proto";
import "types.proto";

message IndexStatusResponse {
  // Number of unmerged index records.
  int64 unmergedRecordCount = 2;
}

message GcInvalidVerticesRequest {
  IndexId indexId = 1;

  // Vertices identified as invalid before cutoff timestamp (Unix timestamp) are garbage collected.
  int64 cutoffTimestamp = 2;
}

message IndexUpdateRequest {
  IndexId  indexId = 1;

  // Optional labels associated with the index.
  map labels = 2;

  oneof update {
    HnswIndexUpdate hnswIndexUpdate = 3;
  }
}

// Service to manage indices.
service IndexService {
  // Create an index.
  rpc Create(IndexDefinition) returns (google.protobuf.Empty) {}

  // Create an index.
  rpc Update(IndexUpdateRequest) returns (google.protobuf.Empty) {}

  // Drop an index.
  rpc Drop(IndexId) returns (google.protobuf.Empty) {}

  // List available indices.
  rpc List(google.protobuf.Empty) returns (IndexDefinitionList) {}

  // Get the index definition.
  rpc Get(IndexId) returns (IndexDefinition) {}

  // Query status of an index.
  // NOTE: API is subject to change.
  rpc GetStatus(IndexId) returns (IndexStatusResponse) {}

  // Garbage collect vertices identified as invalid before cutoff timestamp.
  rpc GcInvalidVertices(GcInvalidVerticesRequest) returns (google.protobuf.Empty) {}
}