public static final class QueryRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder> implements QueryRequestOrBuilder
The request for the `Query` operation.Protobuf type
QueryRequest| Modifier and Type | Method and Description |
|---|---|
QueryRequest.Builder |
addAllQueries(java.lang.Iterable<? extends QueryVector> values)
The query vectors.
|
QueryRequest.Builder |
addQueries(int index,
QueryVector.Builder builderForValue)
The query vectors.
|
QueryRequest.Builder |
addQueries(int index,
QueryVector value)
The query vectors.
|
QueryRequest.Builder |
addQueries(QueryVector.Builder builderForValue)
The query vectors.
|
QueryRequest.Builder |
addQueries(QueryVector value)
The query vectors.
|
QueryVector.Builder |
addQueriesBuilder()
The query vectors.
|
QueryVector.Builder |
addQueriesBuilder(int index)
The query vectors.
|
QueryRequest.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
QueryRequest |
build() |
QueryRequest |
buildPartial() |
QueryRequest.Builder |
clear() |
QueryRequest.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
QueryRequest.Builder |
clearFilter()
The filter to apply if no filter is specified in `QueryVector.
|
QueryRequest.Builder |
clearIncludeMetadata()
Indicates whether metadata is included in the response as well as the ids.
|
QueryRequest.Builder |
clearIncludeValues()
Indicates whether vector values are included in the response.
|
QueryRequest.Builder |
clearNamespace()
The namespace to query.
|
QueryRequest.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
QueryRequest.Builder |
clearQueries()
The query vectors.
|
QueryRequest.Builder |
clearTopK()
The number of results to return for each query.
|
QueryRequest.Builder |
clone() |
QueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
com.google.protobuf.Struct |
getFilter()
The filter to apply if no filter is specified in `QueryVector.
|
com.google.protobuf.Struct.Builder |
getFilterBuilder()
The filter to apply if no filter is specified in `QueryVector.
|
com.google.protobuf.StructOrBuilder |
getFilterOrBuilder()
The filter to apply if no filter is specified in `QueryVector.
|
boolean |
getIncludeMetadata()
Indicates whether metadata is included in the response as well as the ids.
|
boolean |
getIncludeValues()
Indicates whether vector values are included in the response.
|
java.lang.String |
getNamespace()
The namespace to query.
|
com.google.protobuf.ByteString |
getNamespaceBytes()
The namespace to query.
|
QueryVector |
getQueries(int index)
The query vectors.
|
QueryVector.Builder |
getQueriesBuilder(int index)
The query vectors.
|
java.util.List<QueryVector.Builder> |
getQueriesBuilderList()
The query vectors.
|
int |
getQueriesCount()
The query vectors.
|
java.util.List<QueryVector> |
getQueriesList()
The query vectors.
|
QueryVectorOrBuilder |
getQueriesOrBuilder(int index)
The query vectors.
|
java.util.List<? extends QueryVectorOrBuilder> |
getQueriesOrBuilderList()
The query vectors.
|
int |
getTopK()
The number of results to return for each query.
|
boolean |
hasFilter()
The filter to apply if no filter is specified in `QueryVector.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
QueryRequest.Builder |
mergeFilter(com.google.protobuf.Struct value)
The filter to apply if no filter is specified in `QueryVector.
|
QueryRequest.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
QueryRequest.Builder |
mergeFrom(com.google.protobuf.Message other) |
QueryRequest.Builder |
mergeFrom(QueryRequest other) |
QueryRequest.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
QueryRequest.Builder |
removeQueries(int index)
The query vectors.
|
QueryRequest.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
QueryRequest.Builder |
setFilter(com.google.protobuf.Struct.Builder builderForValue)
The filter to apply if no filter is specified in `QueryVector.
|
QueryRequest.Builder |
setFilter(com.google.protobuf.Struct value)
The filter to apply if no filter is specified in `QueryVector.
|
QueryRequest.Builder |
setIncludeMetadata(boolean value)
Indicates whether metadata is included in the response as well as the ids.
|
QueryRequest.Builder |
setIncludeValues(boolean value)
Indicates whether vector values are included in the response.
|
QueryRequest.Builder |
setNamespace(java.lang.String value)
The namespace to query.
|
QueryRequest.Builder |
setNamespaceBytes(com.google.protobuf.ByteString value)
The namespace to query.
|
QueryRequest.Builder |
setQueries(int index,
QueryVector.Builder builderForValue)
The query vectors.
|
QueryRequest.Builder |
setQueries(int index,
QueryVector value)
The query vectors.
|
QueryRequest.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
QueryRequest.Builder |
setTopK(int value)
The number of results to return for each query.
|
QueryRequest.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic QueryRequest build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic QueryRequest buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic QueryRequest.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryRequest.Builder>public QueryRequest.Builder mergeFrom(QueryRequest other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public QueryRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryRequest.Builder>java.io.IOExceptionpublic java.lang.String getNamespace()
The namespace to query.
string namespace = 1 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getNamespace in interface QueryRequestOrBuilderpublic com.google.protobuf.ByteString getNamespaceBytes()
The namespace to query.
string namespace = 1 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getNamespaceBytes in interface QueryRequestOrBuilderpublic QueryRequest.Builder setNamespace(java.lang.String value)
The namespace to query.
string namespace = 1 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }value - The namespace to set.public QueryRequest.Builder clearNamespace()
The namespace to query.
string namespace = 1 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder setNamespaceBytes(com.google.protobuf.ByteString value)
The namespace to query.
string namespace = 1 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }value - The bytes for namespace to set.public int getTopK()
The number of results to return for each query.
uint32 top_k = 2 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getTopK in interface QueryRequestOrBuilderpublic QueryRequest.Builder setTopK(int value)
The number of results to return for each query.
uint32 top_k = 2 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }value - The topK to set.public QueryRequest.Builder clearTopK()
The number of results to return for each query.
uint32 top_k = 2 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public boolean hasFilter()
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }hasFilter in interface QueryRequestOrBuilderpublic com.google.protobuf.Struct getFilter()
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getFilter in interface QueryRequestOrBuilderpublic QueryRequest.Builder setFilter(com.google.protobuf.Struct value)
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder setFilter(com.google.protobuf.Struct.Builder builderForValue)
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder mergeFilter(com.google.protobuf.Struct value)
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder clearFilter()
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public com.google.protobuf.Struct.Builder getFilterBuilder()
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public com.google.protobuf.StructOrBuilder getFilterOrBuilder()
The filter to apply if no filter is specified in `QueryVector. You can use vector metadata to limit your search. See https://www.pinecone.io/docs/metadata-filtering/`
.google.protobuf.Struct filter = 3 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getFilterOrBuilder in interface QueryRequestOrBuilderpublic boolean getIncludeValues()
Indicates whether vector values are included in the response.
bool include_values = 4 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getIncludeValues in interface QueryRequestOrBuilderpublic QueryRequest.Builder setIncludeValues(boolean value)
Indicates whether vector values are included in the response.
bool include_values = 4 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }value - The includeValues to set.public QueryRequest.Builder clearIncludeValues()
Indicates whether vector values are included in the response.
bool include_values = 4 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public boolean getIncludeMetadata()
Indicates whether metadata is included in the response as well as the ids.
bool include_metadata = 5 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getIncludeMetadata in interface QueryRequestOrBuilderpublic QueryRequest.Builder setIncludeMetadata(boolean value)
Indicates whether metadata is included in the response as well as the ids.
bool include_metadata = 5 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }value - The includeMetadata to set.public QueryRequest.Builder clearIncludeMetadata()
Indicates whether metadata is included in the response as well as the ids.
bool include_metadata = 5 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public java.util.List<QueryVector> getQueriesList()
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getQueriesList in interface QueryRequestOrBuilderpublic int getQueriesCount()
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getQueriesCount in interface QueryRequestOrBuilderpublic QueryVector getQueries(int index)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getQueries in interface QueryRequestOrBuilderpublic QueryRequest.Builder setQueries(int index, QueryVector value)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder setQueries(int index, QueryVector.Builder builderForValue)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder addQueries(QueryVector value)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder addQueries(int index, QueryVector value)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder addQueries(QueryVector.Builder builderForValue)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder addQueries(int index, QueryVector.Builder builderForValue)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder addAllQueries(java.lang.Iterable<? extends QueryVector> values)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder clearQueries()
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryRequest.Builder removeQueries(int index)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryVector.Builder getQueriesBuilder(int index)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryVectorOrBuilder getQueriesOrBuilder(int index)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getQueriesOrBuilder in interface QueryRequestOrBuilderpublic java.util.List<? extends QueryVectorOrBuilder> getQueriesOrBuilderList()
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }getQueriesOrBuilderList in interface QueryRequestOrBuilderpublic QueryVector.Builder addQueriesBuilder()
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public QueryVector.Builder addQueriesBuilder(int index)
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public java.util.List<QueryVector.Builder> getQueriesBuilderList()
The query vectors.
repeated .QueryVector queries = 6 [(.grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { ... }public final QueryRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>public final QueryRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<QueryRequest.Builder>