Class SearchDataObjectsRequest.Builder (0.1.0)

public static final class SearchDataObjectsRequest.Builder extends GeneratedMessageV3.Builder<SearchDataObjectsRequest.Builder> implements SearchDataObjectsRequestOrBuilder

Request for performing a single search.

Protobuf type google.cloud.vectorsearch.v1beta.SearchDataObjectsRequest

Inheritance

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

Implements

SearchDataObjectsRequestOrBuilder

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 SearchDataObjectsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

build()

public SearchDataObjectsRequest build()

Returns
Type	Description
SearchDataObjectsRequest

buildPartial()

public SearchDataObjectsRequest buildPartial()

Returns
Type	Description
SearchDataObjectsRequest

clear()

public SearchDataObjectsRequest.Builder clear()

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchDataObjectsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDataObjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

clearPageSize()

public SearchDataObjectsRequest.Builder clearPageSize()

Optional. The standard list page size.

int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchDataObjectsRequest.Builder	This builder for chaining.

clearPageToken()

public SearchDataObjectsRequest.Builder clearPageToken()

Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchDataObjectsRequest.Builder	This builder for chaining.

clearParent()

public SearchDataObjectsRequest.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
SearchDataObjectsRequest.Builder	This builder for chaining.

clearSearchType()

public SearchDataObjectsRequest.Builder clearSearchType()

Returns
Type	Description
SearchDataObjectsRequest.Builder

clearSemanticSearch()

public SearchDataObjectsRequest.Builder clearSemanticSearch()

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Returns
Type	Description
SearchDataObjectsRequest.Builder

clearTextSearch()

public SearchDataObjectsRequest.Builder clearTextSearch()

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchDataObjectsRequest.Builder

clearVectorSearch()

public SearchDataObjectsRequest.Builder clearVectorSearch()

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Returns
Type	Description
SearchDataObjectsRequest.Builder

clone()

public SearchDataObjectsRequest.Builder clone()

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchDataObjectsRequest getDefaultInstanceForType()

Returns
Type	Description
SearchDataObjectsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getPageSize()

public int getPageSize()

Optional. The standard list page size.

int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

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.

getSearchTypeCase()

public SearchDataObjectsRequest.SearchTypeCase getSearchTypeCase()

Returns
Type	Description
SearchDataObjectsRequest.SearchTypeCase

getSemanticSearch()

public SemanticSearch getSemanticSearch()

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Returns
Type	Description
SemanticSearch	The semanticSearch.

getSemanticSearchBuilder()

public SemanticSearch.Builder getSemanticSearchBuilder()

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Returns
Type	Description
SemanticSearch.Builder

getSemanticSearchOrBuilder()

public SemanticSearchOrBuilder getSemanticSearchOrBuilder()

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Returns
Type	Description
SemanticSearchOrBuilder

getTextSearch()

public TextSearch getTextSearch()

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextSearch	The textSearch.

getTextSearchBuilder()

public TextSearch.Builder getTextSearchBuilder()

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextSearch.Builder

getTextSearchOrBuilder()

public TextSearchOrBuilder getTextSearchOrBuilder()

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TextSearchOrBuilder

getVectorSearch()

public VectorSearch getVectorSearch()

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Returns
Type	Description
VectorSearch	The vectorSearch.

getVectorSearchBuilder()

public VectorSearch.Builder getVectorSearchBuilder()

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Returns
Type	Description
VectorSearch.Builder

getVectorSearchOrBuilder()

public VectorSearchOrBuilder getVectorSearchOrBuilder()

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Returns
Type	Description
VectorSearchOrBuilder

hasSemanticSearch()

public boolean hasSemanticSearch()

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Returns
Type	Description
boolean	Whether the semanticSearch field is set.

hasTextSearch()

public boolean hasTextSearch()

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the textSearch field is set.

hasVectorSearch()

public boolean hasVectorSearch()

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

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

public SearchDataObjectsRequest.Builder mergeFrom(SearchDataObjectsRequest other)

Parameter
Name	Description
other	SearchDataObjectsRequest

Returns
Type	Description
SearchDataObjectsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchDataObjectsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

mergeSemanticSearch(SemanticSearch value)

public SearchDataObjectsRequest.Builder mergeSemanticSearch(SemanticSearch value)

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Parameter
Name	Description
value	SemanticSearch

Returns
Type	Description
SearchDataObjectsRequest.Builder

mergeTextSearch(TextSearch value)

public SearchDataObjectsRequest.Builder mergeTextSearch(TextSearch value)

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	TextSearch

Returns
Type	Description
SearchDataObjectsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataObjectsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

mergeVectorSearch(VectorSearch value)

public SearchDataObjectsRequest.Builder mergeVectorSearch(VectorSearch value)

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Parameter
Name	Description
value	VectorSearch

Returns
Type	Description
SearchDataObjectsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

setPageSize(int value)

public SearchDataObjectsRequest.Builder setPageSize(int value)

Optional. The standard list page size.

int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
SearchDataObjectsRequest.Builder	This builder for chaining.

setPageToken(String value)

public SearchDataObjectsRequest.Builder setPageToken(String value)

Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
SearchDataObjectsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchDataObjectsRequest.Builder setPageTokenBytes(ByteString value)

Optional. The standard list page token. Typically obtained via SearchDataObjectsResponse.next_page_token of the previous DataObjectSearchService.SearchDataObjects call.

string page_token = 6 [(.google.api.field_behavior) = OPTIONAL];

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

Returns
Type	Description
SearchDataObjectsRequest.Builder	This builder for chaining.

setParent(String value)

public SearchDataObjectsRequest.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
SearchDataObjectsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public SearchDataObjectsRequest.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
SearchDataObjectsRequest.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

setSemanticSearch(SemanticSearch value)

public SearchDataObjectsRequest.Builder setSemanticSearch(SemanticSearch value)

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Parameter
Name	Description
value	SemanticSearch

Returns
Type	Description
SearchDataObjectsRequest.Builder

setSemanticSearch(SemanticSearch.Builder builderForValue)

public SearchDataObjectsRequest.Builder setSemanticSearch(SemanticSearch.Builder builderForValue)

A semantic search operation.

.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;

Parameter
Name	Description
builderForValue	SemanticSearch.Builder

Returns
Type	Description
SearchDataObjectsRequest.Builder

setTextSearch(TextSearch value)

public SearchDataObjectsRequest.Builder setTextSearch(TextSearch value)

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	TextSearch

Returns
Type	Description
SearchDataObjectsRequest.Builder

setTextSearch(TextSearch.Builder builderForValue)

public SearchDataObjectsRequest.Builder setTextSearch(TextSearch.Builder builderForValue)

Optional. A text search operation.

.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	TextSearch.Builder

Returns
Type	Description
SearchDataObjectsRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataObjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDataObjectsRequest.Builder

Overrides

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

setVectorSearch(VectorSearch value)

public SearchDataObjectsRequest.Builder setVectorSearch(VectorSearch value)

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Parameter
Name	Description
value	VectorSearch

Returns
Type	Description
SearchDataObjectsRequest.Builder

setVectorSearch(VectorSearch.Builder builderForValue)

public SearchDataObjectsRequest.Builder setVectorSearch(VectorSearch.Builder builderForValue)

A vector search operation.

.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;

Parameter
Name	Description
builderForValue	VectorSearch.Builder

Returns
Type	Description
SearchDataObjectsRequest.Builder