io.pinecone.proto.DescribeIndexStatsResponseOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pinecone-client Show documentation
The Pinecone.io Java Client
There is a newer version: 3.0.0
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: vector_service.proto

// Protobuf Java Version: 3.25.3
package io.pinecone.proto;

public interface DescribeIndexStatsResponseOrBuilder extends
    // @@protoc_insertion_point(interface_extends:DescribeIndexStatsResponse)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * A mapping for each namespace in the index from the namespace name to a
   * summary of its contents. If a metadata filter expression is present, the
   * summary will reflect only vectors matching that expression.
   * 
   *
   * map<string, .NamespaceSummary> namespaces = 1;
   */
  int getNamespacesCount();
  /**
   *    * A mapping for each namespace in the index from the namespace name to a
   * summary of its contents. If a metadata filter expression is present, the
   * summary will reflect only vectors matching that expression.
   * 
   *
   * map<string, .NamespaceSummary> namespaces = 1;
   */
  boolean containsNamespaces(
      java.lang.String key);
  /**
   * Use {@link #getNamespacesMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getNamespaces();
  /**
   *    * A mapping for each namespace in the index from the namespace name to a
   * summary of its contents. If a metadata filter expression is present, the
   * summary will reflect only vectors matching that expression.
   * 
   *
   * map<string, .NamespaceSummary> namespaces = 1;
   */
  java.util.Map
  getNamespacesMap();
  /**
   *    * A mapping for each namespace in the index from the namespace name to a
   * summary of its contents. If a metadata filter expression is present, the
   * summary will reflect only vectors matching that expression.
   * 
   *
   * map<string, .NamespaceSummary> namespaces = 1;
   */
  /* nullable */
io.pinecone.proto.NamespaceSummary getNamespacesOrDefault(
      java.lang.String key,
      /* nullable */
io.pinecone.proto.NamespaceSummary defaultValue);
  /**
   *    * A mapping for each namespace in the index from the namespace name to a
   * summary of its contents. If a metadata filter expression is present, the
   * summary will reflect only vectors matching that expression.
   * 
   *
   * map<string, .NamespaceSummary> namespaces = 1;
   */
  io.pinecone.proto.NamespaceSummary getNamespacesOrThrow(
      java.lang.String key);

  /**
   *    * The dimension of the indexed vectors.
   * 
   *
   * uint32 dimension = 2;
   * @return The dimension.
   */
  int getDimension();

  /**
   *    * The fullness of the index, regardless of whether a metadata filter expression was passed. The granularity of this metric is 10%.
   * 
   *
   * float index_fullness = 3;
   * @return The indexFullness.
   */
  float getIndexFullness();

  /**
   *    * The total number of vectors in the index, regardless of whether a metadata filter expression was passed
   * 
   *
   * uint32 total_vector_count = 4;
   * @return The totalVectorCount.
   */
  int getTotalVectorCount();
}