Class SearchHint.Builder (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.4.0
• 0.3.0
• 0.1.0

public static final class SearchHint.Builder extends GeneratedMessage.Builder<SearchHint.Builder> implements SearchHintOrBuilder

Represents a hint to the search index engine.

Protobuf type google.cloud.vectorsearch.v1beta.SearchHint

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchHint.Builder

Implements

SearchHintOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public SearchHint build()

Returns
Type	Description
SearchHint

buildPartial()

public SearchHint buildPartial()

Returns
Type	Description
SearchHint

clear()

public SearchHint.Builder clear()

Returns
Type	Description
SearchHint.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearIndexType()

public SearchHint.Builder clearIndexType()

Returns
Type	Description
SearchHint.Builder

clearUseIndex()

public SearchHint.Builder clearUseIndex()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.Builder

clearUseKnn()

public SearchHint.Builder clearUseKnn()

Optional. If set to true, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

bool use_knn = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchHint getDefaultInstanceForType()

Returns
Type	Description
SearchHint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getIndexTypeCase()

public SearchHint.IndexTypeCase getIndexTypeCase()

Returns
Type	Description
SearchHint.IndexTypeCase

getUseIndex()

public SearchHint.IndexHint getUseIndex()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.IndexHint	The useIndex.

getUseIndexBuilder()

public SearchHint.IndexHint.Builder getUseIndexBuilder()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.IndexHint.Builder

getUseIndexOrBuilder()

public SearchHint.IndexHintOrBuilder getUseIndexOrBuilder()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchHint.IndexHintOrBuilder

getUseKnn()

public boolean getUseKnn()

Optional. If set to true, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

bool use_knn = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The useKnn.

hasUseIndex()

public boolean hasUseIndex()

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the useIndex field is set.

hasUseKnn()

public boolean hasUseKnn()

Optional. If set to true, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

bool use_knn = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the useKnn field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(SearchHint other)

public SearchHint.Builder mergeFrom(SearchHint other)

Parameter
Name	Description
other	SearchHint

Returns
Type	Description
SearchHint.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchHint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchHint.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchHint.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUseIndex(SearchHint.IndexHint value)

public SearchHint.Builder mergeUseIndex(SearchHint.IndexHint value)

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchHint.IndexHint

Returns
Type	Description
SearchHint.Builder

setUseIndex(SearchHint.IndexHint value)

public SearchHint.Builder setUseIndex(SearchHint.IndexHint value)

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	SearchHint.IndexHint

Returns
Type	Description
SearchHint.Builder

setUseIndex(SearchHint.IndexHint.Builder builderForValue)

public SearchHint.Builder setUseIndex(SearchHint.IndexHint.Builder builderForValue)

Optional. Specifies that the search should use a particular index.

.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint use_index = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	SearchHint.IndexHint.Builder

Returns
Type	Description
SearchHint.Builder

setUseKnn(boolean value)

public SearchHint.Builder setUseKnn(boolean value)

Optional. If set to true, the search will use the system's default K-Nearest Neighbor (KNN) index engine.

bool use_knn = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The useKnn to set.

Returns
Type	Description
SearchHint.Builder	This builder for chaining.