Class SearchResponseMetadata.Builder (0.6.0)

Version latest

• 0.6.0 (latest)
• 0.4.0
• 0.3.0
• 0.1.0

public static final class SearchResponseMetadata.Builder extends GeneratedMessage.Builder<SearchResponseMetadata.Builder> implements SearchResponseMetadataOrBuilder

Metadata about the search execution.

Protobuf type google.cloud.vectorsearch.v1beta.SearchResponseMetadata

Inheritance

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

Implements

SearchResponseMetadataOrBuilder

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 SearchResponseMetadata build()

Returns
Type	Description
SearchResponseMetadata

buildPartial()

public SearchResponseMetadata buildPartial()

Returns
Type	Description
SearchResponseMetadata

clear()

public SearchResponseMetadata.Builder clear()

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearIndexType()

public SearchResponseMetadata.Builder clearIndexType()

Returns
Type	Description
SearchResponseMetadata.Builder

clearUsedIndex()

public SearchResponseMetadata.Builder clearUsedIndex()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type	Description
SearchResponseMetadata.Builder

clearUsedKnn()

public SearchResponseMetadata.Builder clearUsedKnn()

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponseMetadata.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchResponseMetadata getDefaultInstanceForType()

Returns
Type	Description
SearchResponseMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getIndexTypeCase()

public SearchResponseMetadata.IndexTypeCase getIndexTypeCase()

Returns
Type	Description
SearchResponseMetadata.IndexTypeCase

getUsedIndex()

public SearchResponseMetadata.IndexInfo getUsedIndex()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type	Description
SearchResponseMetadata.IndexInfo	The usedIndex.

getUsedIndexBuilder()

public SearchResponseMetadata.IndexInfo.Builder getUsedIndexBuilder()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type	Description
SearchResponseMetadata.IndexInfo.Builder

getUsedIndexOrBuilder()

public SearchResponseMetadata.IndexInfoOrBuilder getUsedIndexOrBuilder()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type	Description
SearchResponseMetadata.IndexInfoOrBuilder

getUsedKnn()

public boolean getUsedKnn()

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The usedKnn.

hasUsedIndex()

public boolean hasUsedIndex()

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Returns
Type	Description
boolean	Whether the usedIndex field is set.

hasUsedKnn()

public boolean hasUsedKnn()

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the usedKnn 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(SearchResponseMetadata other)

public SearchResponseMetadata.Builder mergeFrom(SearchResponseMetadata other)

Parameter
Name	Description
other	SearchResponseMetadata

Returns
Type	Description
SearchResponseMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchResponseMetadata.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

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

mergeUsedIndex(SearchResponseMetadata.IndexInfo value)

public SearchResponseMetadata.Builder mergeUsedIndex(SearchResponseMetadata.IndexInfo value)

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Parameter
Name	Description
value	SearchResponseMetadata.IndexInfo

Returns
Type	Description
SearchResponseMetadata.Builder

setUsedIndex(SearchResponseMetadata.IndexInfo value)

public SearchResponseMetadata.Builder setUsedIndex(SearchResponseMetadata.IndexInfo value)

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Parameter
Name	Description
value	SearchResponseMetadata.IndexInfo

Returns
Type	Description
SearchResponseMetadata.Builder

setUsedIndex(SearchResponseMetadata.IndexInfo.Builder builderForValue)

public SearchResponseMetadata.Builder setUsedIndex(SearchResponseMetadata.IndexInfo.Builder builderForValue)

Indicates that the search used a particular index.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;

Parameter
Name	Description
builderForValue	SearchResponseMetadata.IndexInfo.Builder

Returns
Type	Description
SearchResponseMetadata.Builder

setUsedKnn(boolean value)

public SearchResponseMetadata.Builder setUsedKnn(boolean value)

Output only. If true, the search used the system's default K-Nearest Neighbor (KNN) index engine.

bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	boolean The usedKnn to set.

Returns
Type	Description
SearchResponseMetadata.Builder	This builder for chaining.