Class QueryDataObjectsRequest.Builder (0.1.0)

public static final class QueryDataObjectsRequest.Builder extends GeneratedMessageV3.Builder<QueryDataObjectsRequest.Builder> implements QueryDataObjectsRequestOrBuilder

Request message for DataObjectSearchService.QueryDataObjects.

Protobuf type google.cloud.vectorsearch.v1beta.QueryDataObjectsRequest

Inheritance

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

Implements

QueryDataObjectsRequestOrBuilder

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

build()

public QueryDataObjectsRequest build()

Returns
Type	Description
QueryDataObjectsRequest

buildPartial()

public QueryDataObjectsRequest buildPartial()

Returns
Type	Description
QueryDataObjectsRequest

clear()

public QueryDataObjectsRequest.Builder clear()

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public QueryDataObjectsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

clearFilter()

public QueryDataObjectsRequest.Builder clearFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryDataObjectsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public QueryDataObjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

clearOutputFields()

public QueryDataObjectsRequest.Builder clearOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
QueryDataObjectsRequest.Builder

clearPageSize()

public QueryDataObjectsRequest.Builder clearPageSize()

Optional. The standard list page size.

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

Returns
Type	Description
QueryDataObjectsRequest.Builder	This builder for chaining.

clearPageToken()

public QueryDataObjectsRequest.Builder clearPageToken()

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

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

Returns
Type	Description
QueryDataObjectsRequest.Builder	This builder for chaining.

clearParent()

public QueryDataObjectsRequest.Builder clearParent()

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

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

Returns
Type	Description
QueryDataObjectsRequest.Builder	This builder for chaining.

clone()

public QueryDataObjectsRequest.Builder clone()

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public QueryDataObjectsRequest getDefaultInstanceForType()

Returns
Type	Description
QueryDataObjectsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public Struct getFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The filter.

getFilterBuilder()

public Struct.Builder getFilterBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Builder

getFilterOrBuilder()

public StructOrBuilder getFilterOrBuilder()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getOutputFields()

public OutputFields getOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFields	The outputFields.

getOutputFieldsBuilder()

public OutputFields.Builder getOutputFieldsBuilder()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFields.Builder

getOutputFieldsOrBuilder()

public OutputFieldsOrBuilder getOutputFieldsOrBuilder()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
OutputFieldsOrBuilder

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 QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects 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 QueryDataObjectsResponse.next_page_token of the previous DataObjectSearchService.QueryDataObjects 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 query. 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 query. 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.

hasFilter()

public boolean hasFilter()

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the filter field is set.

hasOutputFields()

public boolean hasOutputFields()

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

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

mergeFilter(Struct value)

public QueryDataObjectsRequest.Builder mergeFilter(Struct value)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
QueryDataObjectsRequest.Builder

mergeFrom(QueryDataObjectsRequest other)

public QueryDataObjectsRequest.Builder mergeFrom(QueryDataObjectsRequest other)

Parameter
Name	Description
other	QueryDataObjectsRequest

Returns
Type	Description
QueryDataObjectsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public QueryDataObjectsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

mergeOutputFields(OutputFields value)

public QueryDataObjectsRequest.Builder mergeOutputFields(OutputFields value)

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
QueryDataObjectsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QueryDataObjectsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

setFilter(Struct value)

public QueryDataObjectsRequest.Builder setFilter(Struct value)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	Struct

Returns
Type	Description
QueryDataObjectsRequest.Builder

setFilter(Struct.Builder builderForValue)

public QueryDataObjectsRequest.Builder setFilter(Struct.Builder builderForValue)

Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}}, represented as a google.protobuf.Struct.

.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
QueryDataObjectsRequest.Builder

setOutputFields(OutputFields value)

public QueryDataObjectsRequest.Builder setOutputFields(OutputFields value)

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	OutputFields

Returns
Type	Description
QueryDataObjectsRequest.Builder

setOutputFields(OutputFields.Builder builderForValue)

public QueryDataObjectsRequest.Builder setOutputFields(OutputFields.Builder builderForValue)

Optional. Mask specifying which fields to return.

.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
builderForValue	OutputFields.Builder

Returns
Type	Description
QueryDataObjectsRequest.Builder

setPageSize(int value)

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

setPageToken(String value)

public QueryDataObjectsRequest.Builder setPageToken(String value)

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

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

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
QueryDataObjectsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public QueryDataObjectsRequest.Builder setPageTokenBytes(ByteString value)

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

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

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

Returns
Type	Description
QueryDataObjectsRequest.Builder	This builder for chaining.

setParent(String value)

public QueryDataObjectsRequest.Builder setParent(String value)

Required. The resource name of the Collection for which to query. 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
QueryDataObjectsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public QueryDataObjectsRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Collection for which to query. 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
QueryDataObjectsRequest.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final QueryDataObjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
QueryDataObjectsRequest.Builder

Overrides

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