ScoredVector.Builder (pinecone-java-client 2.0.0 API)

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

All Implemented Interfaces:

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

Enclosing class:

ScoredVector
```
public static final class ScoredVector.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ScoredVector.Builder>
implements ScoredVectorOrBuilder
```
Protobuf type ScoredVector

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScoredVector.Builder`	`addAllValues(java.lang.Iterable<? extends java.lang.Float> values)` This is the vector data, if it is requested.
`ScoredVector.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`ScoredVector.Builder`	`addValues(float value)` This is the vector data, if it is requested.
`ScoredVector`	`build()`
`ScoredVector`	`buildPartial()`
`ScoredVector.Builder`	`clear()`
`ScoredVector.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`ScoredVector.Builder`	`clearId()` This is the vector's unique id.
`ScoredVector.Builder`	`clearMetadata()` This is the metadata, if it is requested.
`ScoredVector.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`ScoredVector.Builder`	`clearScore()` This is a measure of similarity between this vector and the query vector.
`ScoredVector.Builder`	`clearSparseValues()` This is the sparse data, if it is requested.
`ScoredVector.Builder`	`clearValues()` This is the vector data, if it is requested.
`ScoredVector.Builder`	`clone()`
`ScoredVector`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getId()` This is the vector's unique id.
`com.google.protobuf.ByteString`	`getIdBytes()` This is the vector's unique id.
`com.google.protobuf.Struct`	`getMetadata()` This is the metadata, if it is requested.
`com.google.protobuf.Struct.Builder`	`getMetadataBuilder()` This is the metadata, if it is requested.
`com.google.protobuf.StructOrBuilder`	`getMetadataOrBuilder()` This is the metadata, if it is requested.
`float`	`getScore()` This is a measure of similarity between this vector and the query vector.
`SparseValues`	`getSparseValues()` This is the sparse data, if it is requested.
`SparseValues.Builder`	`getSparseValuesBuilder()` This is the sparse data, if it is requested.
`SparseValuesOrBuilder`	`getSparseValuesOrBuilder()` This is the sparse data, if it is requested.
`float`	`getValues(int index)` This is the vector data, if it is requested.
`int`	`getValuesCount()` This is the vector data, if it is requested.
`java.util.List<java.lang.Float>`	`getValuesList()` This is the vector data, if it is requested.
`boolean`	`hasMetadata()` This is the metadata, if it is requested.
`boolean`	`hasSparseValues()` This is the sparse data, if it is requested.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`ScoredVector.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`ScoredVector.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`ScoredVector.Builder`	`mergeFrom(ScoredVector other)`
`ScoredVector.Builder`	`mergeMetadata(com.google.protobuf.Struct value)` This is the metadata, if it is requested.
`ScoredVector.Builder`	`mergeSparseValues(SparseValues value)` This is the sparse data, if it is requested.
`ScoredVector.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ScoredVector.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`ScoredVector.Builder`	`setId(java.lang.String value)` This is the vector's unique id.
`ScoredVector.Builder`	`setIdBytes(com.google.protobuf.ByteString value)` This is the vector's unique id.
`ScoredVector.Builder`	`setMetadata(com.google.protobuf.Struct.Builder builderForValue)` This is the metadata, if it is requested.
`ScoredVector.Builder`	`setMetadata(com.google.protobuf.Struct value)` This is the metadata, if it is requested.
`ScoredVector.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`ScoredVector.Builder`	`setScore(float value)` This is a measure of similarity between this vector and the query vector.
`ScoredVector.Builder`	`setSparseValues(SparseValues.Builder builderForValue)` This is the sparse data, if it is requested.
`ScoredVector.Builder`	`setSparseValues(SparseValues value)` This is the sparse data, if it is requested.
`ScoredVector.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`ScoredVector.Builder`	`setValues(int index, float value)` This is the vector data, if it is requested.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, 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, 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

- 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<ScoredVector.Builder>
  - clear
```
public ScoredVector.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<ScoredVector.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<ScoredVector.Builder>
  - getDefaultInstanceForType
```
public ScoredVector getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public ScoredVector build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public ScoredVector buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public ScoredVector.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<ScoredVector.Builder>
  - setField
```
public ScoredVector.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<ScoredVector.Builder>
  - clearField
```
public ScoredVector.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<ScoredVector.Builder>
  - clearOneof
```
public ScoredVector.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<ScoredVector.Builder>
  - setRepeatedField
```
public ScoredVector.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<ScoredVector.Builder>
  - addRepeatedField
```
public ScoredVector.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<ScoredVector.Builder>
  - mergeFrom
```
public ScoredVector.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<ScoredVector.Builder>
  - mergeFrom
```
public ScoredVector.Builder mergeFrom(ScoredVector other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ScoredVector.Builder>
  - mergeFrom
```
public ScoredVector.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<ScoredVector.Builder>
    
    Throws:
    
    java.io.IOException
  - getId
```
public java.lang.String getId()
```
```
 This is the vector's unique id.
 
```
    string id = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getId in interface ScoredVectorOrBuilder
    
    Returns:
    
    The id.
  - getIdBytes
```
public com.google.protobuf.ByteString getIdBytes()
```
```
 This is the vector's unique id.
 
```
    string id = 1 [(.google.api.field_behavior) = REQUIRED];
    Specified by:
    
    getIdBytes in interface ScoredVectorOrBuilder
    
    Returns:
    
    The bytes for id.
  - setId
```
public ScoredVector.Builder setId(java.lang.String value)
```
```
 This is the vector's unique id.
 
```
    string id = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The id to set.
    
    Returns:
    
    This builder for chaining.
  - clearId
```
public ScoredVector.Builder clearId()
```
```
 This is the vector's unique id.
 
```
    string id = 1 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    This builder for chaining.
  - setIdBytes
```
public ScoredVector.Builder setIdBytes(com.google.protobuf.ByteString value)
```
```
 This is the vector's unique id.
 
```
    string id = 1 [(.google.api.field_behavior) = REQUIRED];
    Parameters:
    
    value - The bytes for id to set.
    
    Returns:
    
    This builder for chaining.
  - getScore
```
public float getScore()
```
```
 This is a measure of similarity between this vector and the query vector.  The higher the score, the more they are similar.
 
```
    float score = 2;
    Specified by:
    
    getScore in interface ScoredVectorOrBuilder
    
    Returns:
    
    The score.
  - setScore
```
public ScoredVector.Builder setScore(float value)
```
```
 This is a measure of similarity between this vector and the query vector.  The higher the score, the more they are similar.
 
```
    float score = 2;
    Parameters:
    
    value - The score to set.
    
    Returns:
    
    This builder for chaining.
  - clearScore
```
public ScoredVector.Builder clearScore()
```
```
 This is a measure of similarity between this vector and the query vector.  The higher the score, the more they are similar.
 
```
    float score = 2;
    Returns:
    
    This builder for chaining.
  - getValuesList
```
public java.util.List<java.lang.Float> getValuesList()
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Specified by:
    
    getValuesList in interface ScoredVectorOrBuilder
    
    Returns:
    
    A list containing the values.
  - getValuesCount
```
public int getValuesCount()
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Specified by:
    
    getValuesCount in interface ScoredVectorOrBuilder
    
    Returns:
    
    The count of values.
  - getValues
```
public float getValues(int index)
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Specified by:
    
    getValues in interface ScoredVectorOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The values at the given index.
  - setValues
```
public ScoredVector.Builder setValues(int index,
                                      float value)
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Parameters:
    
    index - The index to set the value at.
    
    value - The values to set.
    
    Returns:
    
    This builder for chaining.
  - addValues
```
public ScoredVector.Builder addValues(float value)
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Parameters:
    
    value - The values to add.
    
    Returns:
    
    This builder for chaining.
  - addAllValues
```
public ScoredVector.Builder addAllValues(java.lang.Iterable<? extends java.lang.Float> values)
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Parameters:
    
    values - The values to add.
    
    Returns:
    
    This builder for chaining.
  - clearValues
```
public ScoredVector.Builder clearValues()
```
```
 This is the vector data, if it is requested.
 
```
    repeated float values = 3;
    Returns:
    
    This builder for chaining.
  - hasSparseValues
```
public boolean hasSparseValues()
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
    Specified by:
    
    hasSparseValues in interface ScoredVectorOrBuilder
    
    Returns:
    
    Whether the sparseValues field is set.
  - getSparseValues
```
public SparseValues getSparseValues()
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
    Specified by:
    
    getSparseValues in interface ScoredVectorOrBuilder
    
    Returns:
    
    The sparseValues.
  - setSparseValues
```
public ScoredVector.Builder setSparseValues(SparseValues value)
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
  - setSparseValues
```
public ScoredVector.Builder setSparseValues(SparseValues.Builder builderForValue)
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
  - mergeSparseValues
```
public ScoredVector.Builder mergeSparseValues(SparseValues value)
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
  - clearSparseValues
```
public ScoredVector.Builder clearSparseValues()
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
  - getSparseValuesBuilder
```
public SparseValues.Builder getSparseValuesBuilder()
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
  - getSparseValuesOrBuilder
```
public SparseValuesOrBuilder getSparseValuesOrBuilder()
```
```
 This is the sparse data, if it is requested.
 
```
    .SparseValues sparse_values = 5;
    Specified by:
    
    getSparseValuesOrBuilder in interface ScoredVectorOrBuilder
  - hasMetadata
```
public boolean hasMetadata()
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
    Specified by:
    
    hasMetadata in interface ScoredVectorOrBuilder
    
    Returns:
    
    Whether the metadata field is set.
  - getMetadata
```
public com.google.protobuf.Struct getMetadata()
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
    Specified by:
    
    getMetadata in interface ScoredVectorOrBuilder
    
    Returns:
    
    The metadata.
  - setMetadata
```
public ScoredVector.Builder setMetadata(com.google.protobuf.Struct value)
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
  - setMetadata
```
public ScoredVector.Builder setMetadata(com.google.protobuf.Struct.Builder builderForValue)
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
  - mergeMetadata
```
public ScoredVector.Builder mergeMetadata(com.google.protobuf.Struct value)
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
  - clearMetadata
```
public ScoredVector.Builder clearMetadata()
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
  - getMetadataBuilder
```
public com.google.protobuf.Struct.Builder getMetadataBuilder()
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
  - getMetadataOrBuilder
```
public com.google.protobuf.StructOrBuilder getMetadataOrBuilder()
```
```
 This is the metadata, if it is requested.
 
```
    .google.protobuf.Struct metadata = 4;
    Specified by:
    
    getMetadataOrBuilder in interface ScoredVectorOrBuilder
  - setUnknownFields
```
public final ScoredVector.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<ScoredVector.Builder>
  - mergeUnknownFields
```
public final ScoredVector.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<ScoredVector.Builder>

Class ScoredVector.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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getId

getIdBytes

setId

clearId

setIdBytes

getScore

setScore

clearScore

getValuesList

getValuesCount

getValues

setValues

addValues

addAllValues

clearValues

hasSparseValues

getSparseValues

setSparseValues

setSparseValues

mergeSparseValues

clearSparseValues

getSparseValuesBuilder

getSparseValuesOrBuilder

hasMetadata

getMetadata

setMetadata

setMetadata

mergeMetadata

clearMetadata

getMetadataBuilder

getMetadataOrBuilder

setUnknownFields

mergeUnknownFields