io.pinecone.proto.DeleteRequestOrBuilder 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 DeleteRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:DeleteRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Vectors to delete.
   * 
   *
   * repeated string ids = 1;
   * @return A list containing the ids.
   */
  java.util.List
      getIdsList();
  /**
   *    * Vectors to delete.
   * 
   *
   * repeated string ids = 1;
   * @return The count of ids.
   */
  int getIdsCount();
  /**
   *    * Vectors to delete.
   * 
   *
   * repeated string ids = 1;
   * @param index The index of the element to return.
   * @return The ids at the given index.
   */
  java.lang.String getIds(int index);
  /**
   *    * Vectors to delete.
   * 
   *
   * repeated string ids = 1;
   * @param index The index of the value to return.
   * @return The bytes of the ids at the given index.
   */
  com.google.protobuf.ByteString
      getIdsBytes(int index);

  /**
   *    * This indicates that all vectors in the index namespace should be deleted.
   * 
   *
   * bool delete_all = 2;
   * @return The deleteAll.
   */
  boolean getDeleteAll();

  /**
   *    * The namespace to delete vectors from, if applicable.
   * 
   *
   * string namespace = 3;
   * @return The namespace.
   */
  java.lang.String getNamespace();
  /**
   *    * The namespace to delete vectors from, if applicable.
   * 
   *
   * string namespace = 3;
   * @return The bytes for namespace.
   */
  com.google.protobuf.ByteString
      getNamespaceBytes();

  /**
   *    * If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive
   * with specifying ids to delete in the ids param or using delete_all=True.
   * See https://www.pinecone.io/docs/metadata-filtering/.
   * 
   *
   * .google.protobuf.Struct filter = 4;
   * @return Whether the filter field is set.
   */
  boolean hasFilter();
  /**
   *    * If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive
   * with specifying ids to delete in the ids param or using delete_all=True.
   * See https://www.pinecone.io/docs/metadata-filtering/.
   * 
   *
   * .google.protobuf.Struct filter = 4;
   * @return The filter.
   */
  com.google.protobuf.Struct getFilter();
  /**
   *    * If specified, the metadata filter here will be used to select the vectors to delete. This is mutually exclusive
   * with specifying ids to delete in the ids param or using delete_all=True.
   * See https://www.pinecone.io/docs/metadata-filtering/.
   * 
   *
   * .google.protobuf.Struct filter = 4;
   */
  com.google.protobuf.StructOrBuilder getFilterOrBuilder();
}