Class SearchDataObjectsResponse.Builder (0.1.0)

public static final class SearchDataObjectsResponse.Builder extends GeneratedMessageV3.Builder<SearchDataObjectsResponse.Builder> implements SearchDataObjectsResponseOrBuilder

Response for a search request.

Protobuf type google.cloud.vectorsearch.v1beta.SearchDataObjectsResponse

Inheritance

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

Implements

SearchDataObjectsResponseOrBuilder

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

addAllResults(Iterable<? extends SearchResult> values)

public SearchDataObjectsResponse.Builder addAllResults(Iterable<? extends SearchResult> values)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type	Description
SearchDataObjectsResponse.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

addResults(SearchResult value)

public SearchDataObjectsResponse.Builder addResults(SearchResult value)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	SearchResult

Returns
Type	Description
SearchDataObjectsResponse.Builder

addResults(SearchResult.Builder builderForValue)

public SearchDataObjectsResponse.Builder addResults(SearchResult.Builder builderForValue)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	SearchResult.Builder

Returns
Type	Description
SearchDataObjectsResponse.Builder

addResults(int index, SearchResult value)

public SearchDataObjectsResponse.Builder addResults(int index, SearchResult value)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
value	SearchResult

Returns
Type	Description
SearchDataObjectsResponse.Builder

addResults(int index, SearchResult.Builder builderForValue)

public SearchDataObjectsResponse.Builder addResults(int index, SearchResult.Builder builderForValue)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
builderForValue	SearchResult.Builder

Returns
Type	Description
SearchDataObjectsResponse.Builder

addResultsBuilder()

public SearchResult.Builder addResultsBuilder()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResult.Builder

addResultsBuilder(int index)

public SearchResult.Builder addResultsBuilder(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResult.Builder

build()

public SearchDataObjectsResponse build()

Returns
Type	Description
SearchDataObjectsResponse

buildPartial()

public SearchDataObjectsResponse buildPartial()

Returns
Type	Description
SearchDataObjectsResponse

clear()

public SearchDataObjectsResponse.Builder clear()

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchDataObjectsResponse.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

clearNextPageToken()

public SearchDataObjectsResponse.Builder clearNextPageToken()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchDataObjectsResponse.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchDataObjectsResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

clearResults()

public SearchDataObjectsResponse.Builder clearResults()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchDataObjectsResponse.Builder

clearSearchResponseMetadata()

public SearchDataObjectsResponse.Builder clearSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchDataObjectsResponse.Builder

clone()

public SearchDataObjectsResponse.Builder clone()

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchDataObjectsResponse getDefaultInstanceForType()

Returns
Type	Description
SearchDataObjectsResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getNextPageToken()

public String getNextPageToken()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for nextPageToken.

getResults(int index)

public SearchResult getResults(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResult

getResultsBuilder(int index)

public SearchResult.Builder getResultsBuilder(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResult.Builder

getResultsBuilderList()

public List<SearchResult.Builder> getResultsBuilderList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Builder>

getResultsCount()

public int getResultsCount()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getResultsList()

public List<SearchResult> getResultsList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<SearchResult>

getResultsOrBuilder(int index)

public SearchResultOrBuilder getResultsOrBuilder(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchResultOrBuilder

getResultsOrBuilderList()

public List<? extends SearchResultOrBuilder> getResultsOrBuilderList()

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getSearchResponseMetadata()

public SearchResponseMetadata getSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponseMetadata	The searchResponseMetadata.

getSearchResponseMetadataBuilder()

public SearchResponseMetadata.Builder getSearchResponseMetadataBuilder()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponseMetadata.Builder

getSearchResponseMetadataOrBuilder()

public SearchResponseMetadataOrBuilder getSearchResponseMetadataOrBuilder()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
SearchResponseMetadataOrBuilder

hasSearchResponseMetadata()

public boolean hasSearchResponseMetadata()

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

public SearchDataObjectsResponse.Builder mergeFrom(SearchDataObjectsResponse other)

Parameter
Name	Description
other	SearchDataObjectsResponse

Returns
Type	Description
SearchDataObjectsResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchDataObjectsResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

mergeSearchResponseMetadata(SearchResponseMetadata value)

public SearchDataObjectsResponse.Builder mergeSearchResponseMetadata(SearchResponseMetadata value)

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	SearchResponseMetadata

Returns
Type	Description
SearchDataObjectsResponse.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataObjectsResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

removeResults(int index)

public SearchDataObjectsResponse.Builder removeResults(int index)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
SearchDataObjectsResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

setNextPageToken(String value)

public SearchDataObjectsResponse.Builder setNextPageToken(String value)

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The nextPageToken to set.

Returns
Type	Description
SearchDataObjectsResponse.Builder	This builder for chaining.

setNextPageTokenBytes(ByteString value)

public SearchDataObjectsResponse.Builder setNextPageTokenBytes(ByteString value)

Output only. A token to retrieve next page of results. Pass to [DataObjectSearchService.SearchDataObjectsRequest.page_token][] to obtain that page.

string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

Returns
Type	Description
SearchDataObjectsResponse.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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

setResults(int index, SearchResult value)

public SearchDataObjectsResponse.Builder setResults(int index, SearchResult value)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
value	SearchResult

Returns
Type	Description
SearchDataObjectsResponse.Builder

setResults(int index, SearchResult.Builder builderForValue)

public SearchDataObjectsResponse.Builder setResults(int index, SearchResult.Builder builderForValue)

Output only. The list of dataObjects that match the search criteria.

repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
builderForValue	SearchResult.Builder

Returns
Type	Description
SearchDataObjectsResponse.Builder

setSearchResponseMetadata(SearchResponseMetadata value)

public SearchDataObjectsResponse.Builder setSearchResponseMetadata(SearchResponseMetadata value)

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	SearchResponseMetadata

Returns
Type	Description
SearchDataObjectsResponse.Builder

setSearchResponseMetadata(SearchResponseMetadata.Builder builderForValue)

public SearchDataObjectsResponse.Builder setSearchResponseMetadata(SearchResponseMetadata.Builder builderForValue)

Output only. Metadata about the search execution.

.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	SearchResponseMetadata.Builder

Returns
Type	Description
SearchDataObjectsResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchDataObjectsResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchDataObjectsResponse.Builder

Overrides

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