Class SearchResponseMetadata.Builder (0.1.0)

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

Metadata about the search execution.

Protobuf type google.cloud.vectorsearch.v1beta.SearchResponseMetadata

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchResponseMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchResponseMetadata.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearIndexType()

public SearchResponseMetadata.Builder clearIndexType()

Returns
Type	Description
SearchResponseMetadata.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchResponseMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.

clone()

public SearchResponseMetadata.Builder clone()

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchResponseMetadata getDefaultInstanceForType()

Returns
Type	Description
SearchResponseMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.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)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponseMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

public SearchResponseMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchResponseMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchResponseMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchResponseMetadata.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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.