QueryVector.Builder (pinecone-java-client 0.3.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
    - - io.pinecone.proto.QueryVector.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryVectorOrBuilder, java.lang.Cloneable

Enclosing class:

QueryVector
```
public static final class QueryVector.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
implements QueryVectorOrBuilder
```
```
 A single query vector within a `QueryRequest`.
 
```
Protobuf type QueryVector

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryVector.Builder`	`addAllValues(java.lang.Iterable<? extends java.lang.Float> values)` The query vector values.
`QueryVector.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`QueryVector.Builder`	`addValues(float value)` The query vector values.
`QueryVector`	`build()`
`QueryVector`	`buildPartial()`
`QueryVector.Builder`	`clear()`
`QueryVector.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`QueryVector.Builder`	`clearFilter()` An override for the metadata filter to apply.
`QueryVector.Builder`	`clearNamespace()` An override the namespace to search.
`QueryVector.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`QueryVector.Builder`	`clearSparseValues()` The query sparse values.
`QueryVector.Builder`	`clearTopK()` An override for the number of results to return for this query vector.
`QueryVector.Builder`	`clearValues()` The query vector values.
`QueryVector.Builder`	`clone()`
`QueryVector`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`com.google.protobuf.Struct`	`getFilter()` An override for the metadata filter to apply.
`com.google.protobuf.Struct.Builder`	`getFilterBuilder()` An override for the metadata filter to apply.
`com.google.protobuf.StructOrBuilder`	`getFilterOrBuilder()` An override for the metadata filter to apply.
`java.lang.String`	`getNamespace()` An override the namespace to search.
`com.google.protobuf.ByteString`	`getNamespaceBytes()` An override the namespace to search.
`SparseValues`	`getSparseValues()` The query sparse values.
`SparseValues.Builder`	`getSparseValuesBuilder()` The query sparse values.
`SparseValuesOrBuilder`	`getSparseValuesOrBuilder()` The query sparse values.
`int`	`getTopK()` An override for the number of results to return for this query vector.
`float`	`getValues(int index)` The query vector values.
`int`	`getValuesCount()` The query vector values.
`java.util.List<java.lang.Float>`	`getValuesList()` The query vector values.
`boolean`	`hasFilter()` An override for the metadata filter to apply.
`boolean`	`hasSparseValues()` The query sparse values.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`QueryVector.Builder`	`mergeFilter(com.google.protobuf.Struct value)` An override for the metadata filter to apply.
`QueryVector.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`QueryVector.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`QueryVector.Builder`	`mergeFrom(QueryVector other)`
`QueryVector.Builder`	`mergeSparseValues(SparseValues value)` The query sparse values.
`QueryVector.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`QueryVector.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`QueryVector.Builder`	`setFilter(com.google.protobuf.Struct.Builder builderForValue)` An override for the metadata filter to apply.
`QueryVector.Builder`	`setFilter(com.google.protobuf.Struct value)` An override for the metadata filter to apply.
`QueryVector.Builder`	`setNamespace(java.lang.String value)` An override the namespace to search.
`QueryVector.Builder`	`setNamespaceBytes(com.google.protobuf.ByteString value)` An override the namespace to search.
`QueryVector.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`QueryVector.Builder`	`setSparseValues(SparseValues.Builder builderForValue)` The query sparse values.
`QueryVector.Builder`	`setSparseValues(SparseValues value)` The query sparse values.
`QueryVector.Builder`	`setTopK(int value)` An override for the number of results to return for this query vector.
`QueryVector.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`QueryVector.Builder`	`setValues(int index, float value)` The query vector values.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - clear
```
public QueryVector.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - getDefaultInstanceForType
```
public QueryVector getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public QueryVector build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public QueryVector buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public QueryVector.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - setField
```
public QueryVector.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    java.lang.Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - clearField
```
public QueryVector.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - clearOneof
```
public QueryVector.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - setRepeatedField
```
public QueryVector.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            java.lang.Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - addRepeatedField
```
public QueryVector.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            java.lang.Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - mergeFrom
```
public QueryVector.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryVector.Builder>
  - mergeFrom
```
public QueryVector.Builder mergeFrom(QueryVector other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - mergeFrom
```
public QueryVector.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryVector.Builder>
    
    Throws:
    
    java.io.IOException
  - getValuesList
```
public java.util.List<java.lang.Float> getValuesList()
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Specified by:
    
    getValuesList in interface QueryVectorOrBuilder
    
    Returns:
    
    A list containing the values.
  - getValuesCount
```
public int getValuesCount()
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Specified by:
    
    getValuesCount in interface QueryVectorOrBuilder
    
    Returns:
    
    The count of values.
  - getValues
```
public float getValues(int index)
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Specified by:
    
    getValues in interface QueryVectorOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The values at the given index.
  - setValues
```
public QueryVector.Builder setValues(int index,
                                     float value)
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Parameters:
    
    index - The index to set the value at.
    
    value - The values to set.
    
    Returns:
    
    This builder for chaining.
  - addValues
```
public QueryVector.Builder addValues(float value)
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Parameters:
    
    value - The values to add.
    
    Returns:
    
    This builder for chaining.
  - addAllValues
```
public QueryVector.Builder addAllValues(java.lang.Iterable<? extends java.lang.Float> values)
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Parameters:
    
    values - The values to add.
    
    Returns:
    
    This builder for chaining.
  - clearValues
```
public QueryVector.Builder clearValues()
```
```
 The query vector values. This should be the same length as the dimension of the index being queried.
 
```
    repeated float values = 1;
    Returns:
    
    This builder for chaining.
  - hasSparseValues
```
public boolean hasSparseValues()
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
    Specified by:
    
    hasSparseValues in interface QueryVectorOrBuilder
    
    Returns:
    
    Whether the sparseValues field is set.
  - getSparseValues
```
public SparseValues getSparseValues()
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
    Specified by:
    
    getSparseValues in interface QueryVectorOrBuilder
    
    Returns:
    
    The sparseValues.
  - setSparseValues
```
public QueryVector.Builder setSparseValues(SparseValues value)
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
  - setSparseValues
```
public QueryVector.Builder setSparseValues(SparseValues.Builder builderForValue)
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
  - mergeSparseValues
```
public QueryVector.Builder mergeSparseValues(SparseValues value)
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
  - clearSparseValues
```
public QueryVector.Builder clearSparseValues()
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
  - getSparseValuesBuilder
```
public SparseValues.Builder getSparseValuesBuilder()
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
  - getSparseValuesOrBuilder
```
public SparseValuesOrBuilder getSparseValuesOrBuilder()
```
```
 The query sparse values.
 
```
    .SparseValues sparse_values = 5;
    Specified by:
    
    getSparseValuesOrBuilder in interface QueryVectorOrBuilder
  - getTopK
```
public int getTopK()
```
```
 An override for the number of results to return for this query vector.
 
```
    uint32 top_k = 2;
    Specified by:
    
    getTopK in interface QueryVectorOrBuilder
    
    Returns:
    
    The topK.
  - setTopK
```
public QueryVector.Builder setTopK(int value)
```
```
 An override for the number of results to return for this query vector.
 
```
    uint32 top_k = 2;
    Parameters:
    
    value - The topK to set.
    
    Returns:
    
    This builder for chaining.
  - clearTopK
```
public QueryVector.Builder clearTopK()
```
```
 An override for the number of results to return for this query vector.
 
```
    uint32 top_k = 2;
    Returns:
    
    This builder for chaining.
  - getNamespace
```
public java.lang.String getNamespace()
```
```
 An override the namespace to search.
 
```
    string namespace = 3;
    Specified by:
    
    getNamespace in interface QueryVectorOrBuilder
    
    Returns:
    
    The namespace.
  - getNamespaceBytes
```
public com.google.protobuf.ByteString getNamespaceBytes()
```
```
 An override the namespace to search.
 
```
    string namespace = 3;
    Specified by:
    
    getNamespaceBytes in interface QueryVectorOrBuilder
    
    Returns:
    
    The bytes for namespace.
  - setNamespace
```
public QueryVector.Builder setNamespace(java.lang.String value)
```
```
 An override the namespace to search.
 
```
    string namespace = 3;
    Parameters:
    
    value - The namespace to set.
    
    Returns:
    
    This builder for chaining.
  - clearNamespace
```
public QueryVector.Builder clearNamespace()
```
```
 An override the namespace to search.
 
```
    string namespace = 3;
    Returns:
    
    This builder for chaining.
  - setNamespaceBytes
```
public QueryVector.Builder setNamespaceBytes(com.google.protobuf.ByteString value)
```
```
 An override the namespace to search.
 
```
    string namespace = 3;
    Parameters:
    
    value - The bytes for namespace to set.
    
    Returns:
    
    This builder for chaining.
  - hasFilter
```
public boolean hasFilter()
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
    Specified by:
    
    hasFilter in interface QueryVectorOrBuilder
    
    Returns:
    
    Whether the filter field is set.
  - getFilter
```
public com.google.protobuf.Struct getFilter()
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
    Specified by:
    
    getFilter in interface QueryVectorOrBuilder
    
    Returns:
    
    The filter.
  - setFilter
```
public QueryVector.Builder setFilter(com.google.protobuf.Struct value)
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
  - setFilter
```
public QueryVector.Builder setFilter(com.google.protobuf.Struct.Builder builderForValue)
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
  - mergeFilter
```
public QueryVector.Builder mergeFilter(com.google.protobuf.Struct value)
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
  - clearFilter
```
public QueryVector.Builder clearFilter()
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
  - getFilterBuilder
```
public com.google.protobuf.Struct.Builder getFilterBuilder()
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
  - getFilterOrBuilder
```
public com.google.protobuf.StructOrBuilder getFilterOrBuilder()
```
```
 An override for the metadata filter to apply. This replaces the request-level filter.
 
```
    .google.protobuf.Struct filter = 4;
    Specified by:
    
    getFilterOrBuilder in interface QueryVectorOrBuilder
  - setUnknownFields
```
public final QueryVector.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>
  - mergeUnknownFields
```
public final QueryVector.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryVector.Builder>

Class QueryVector.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getValuesList

getValuesCount

getValues

setValues

addValues

addAllValues

clearValues

hasSparseValues

getSparseValues

setSparseValues

setSparseValues

mergeSparseValues

clearSparseValues

getSparseValuesBuilder

getSparseValuesOrBuilder

getTopK

setTopK

clearTopK

getNamespace

getNamespaceBytes

setNamespace

clearNamespace

setNamespaceBytes

hasFilter

getFilter

setFilter

setFilter

mergeFilter

clearFilter

getFilterBuilder

getFilterOrBuilder

setUnknownFields

mergeUnknownFields