Class BatchSearchDataObjectsRequest.Builder (0.1.0)

public static final class BatchSearchDataObjectsRequest.Builder extends GeneratedMessageV3.Builder<BatchSearchDataObjectsRequest.Builder> implements BatchSearchDataObjectsRequestOrBuilder

A request to perform a batch of search operations.

Protobuf type google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BatchSearchDataObjectsRequest.Builder

Implements

BatchSearchDataObjectsRequestOrBuilder

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

addAllSearches(Iterable<? extends Search> values)

public BatchSearchDataObjectsRequest.Builder addAllSearches(Iterable<? extends Search> values)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.vectorsearch.v1beta.Search>

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

addSearches(Search value)

public BatchSearchDataObjectsRequest.Builder addSearches(Search value)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Search

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

addSearches(Search.Builder builderForValue)

public BatchSearchDataObjectsRequest.Builder addSearches(Search.Builder builderForValue)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	Search.Builder

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

addSearches(int index, Search value)

public BatchSearchDataObjectsRequest.Builder addSearches(int index, Search value)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
value	Search

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

addSearches(int index, Search.Builder builderForValue)

public BatchSearchDataObjectsRequest.Builder addSearches(int index, Search.Builder builderForValue)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
builderForValue	Search.Builder

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

addSearchesBuilder()

public Search.Builder addSearchesBuilder()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Search.Builder

addSearchesBuilder(int index)

public Search.Builder addSearchesBuilder(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Search.Builder

build()

public BatchSearchDataObjectsRequest build()

Returns
Type	Description
BatchSearchDataObjectsRequest

buildPartial()

public BatchSearchDataObjectsRequest buildPartial()

Returns
Type	Description
BatchSearchDataObjectsRequest

clear()

public BatchSearchDataObjectsRequest.Builder clear()

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCombine()

public BatchSearchDataObjectsRequest.Builder clearCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public BatchSearchDataObjectsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public BatchSearchDataObjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

clearParent()

public BatchSearchDataObjectsRequest.Builder clearParent()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder	This builder for chaining.

clearSearches()

public BatchSearchDataObjectsRequest.Builder clearSearches()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

clone()

public BatchSearchDataObjectsRequest.Builder clone()

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCombine()

public BatchSearchDataObjectsRequest.CombineResultsOptions getCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions	The combine.

getCombineBuilder()

public BatchSearchDataObjectsRequest.CombineResultsOptions.Builder getCombineBuilder()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

getCombineOrBuilder()

public BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder getCombineOrBuilder()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder

getDefaultInstanceForType()

public BatchSearchDataObjectsRequest getDefaultInstanceForType()

Returns
Type	Description
BatchSearchDataObjectsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getParent()

public String getParent()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getSearches(int index)

public Search getSearches(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Search

getSearchesBuilder(int index)

public Search.Builder getSearchesBuilder(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
Search.Builder

getSearchesBuilderList()

public List<Search.Builder> getSearchesBuilderList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Builder>

getSearchesCount()

public int getSearchesCount()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getSearchesList()

public List<Search> getSearchesList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<Search>

getSearchesOrBuilder(int index)

public SearchOrBuilder getSearchesOrBuilder(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchOrBuilder

getSearchesOrBuilderList()

public List<? extends SearchOrBuilder> getSearchesOrBuilderList()

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
List<? extends com.google.cloud.vectorsearch.v1beta.SearchOrBuilder>

hasCombine()

public boolean hasCombine()

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

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

mergeCombine(BatchSearchDataObjectsRequest.CombineResultsOptions value)

public BatchSearchDataObjectsRequest.Builder mergeCombine(BatchSearchDataObjectsRequest.CombineResultsOptions value)

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BatchSearchDataObjectsRequest.CombineResultsOptions

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

mergeFrom(BatchSearchDataObjectsRequest other)

public BatchSearchDataObjectsRequest.Builder mergeFrom(BatchSearchDataObjectsRequest other)

Parameter
Name	Description
other	BatchSearchDataObjectsRequest

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public BatchSearchDataObjectsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BatchSearchDataObjectsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

removeSearches(int index)

public BatchSearchDataObjectsRequest.Builder removeSearches(int index)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
index	int

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

setCombine(BatchSearchDataObjectsRequest.CombineResultsOptions value)

public BatchSearchDataObjectsRequest.Builder setCombine(BatchSearchDataObjectsRequest.CombineResultsOptions value)

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	BatchSearchDataObjectsRequest.CombineResultsOptions

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

setCombine(BatchSearchDataObjectsRequest.CombineResultsOptions.Builder builderForValue)

public BatchSearchDataObjectsRequest.Builder setCombine(BatchSearchDataObjectsRequest.CombineResultsOptions.Builder builderForValue)

Optional. Options for combining the results of the batch search operations.

.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	BatchSearchDataObjectsRequest.CombineResultsOptions.Builder

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

setParent(String value)

public BatchSearchDataObjectsRequest.Builder setParent(String value)

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public BatchSearchDataObjectsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Collection for which to search. Format: projects/{project}/locations/{location}/collections/{collection}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	ByteString The bytes for parent to set.

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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

setSearches(int index, Search value)

public BatchSearchDataObjectsRequest.Builder setSearches(int index, Search value)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
value	Search

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

setSearches(int index, Search.Builder builderForValue)

public BatchSearchDataObjectsRequest.Builder setSearches(int index, Search.Builder builderForValue)

Required. A list of search requests to execute in parallel.

repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
index	int
builderForValue	Search.Builder

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final BatchSearchDataObjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
BatchSearchDataObjectsRequest.Builder

Overrides

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