Class QueryDataObjectsRequest (0.1.0)
public final class QueryDataObjectsRequest extends GeneratedMessageV3 implements QueryDataObjectsRequestOrBuilder
Request message for
DataObjectSearchService.QueryDataObjects.
Protobuf type google.cloud.vectorsearch.v1beta.QueryDataObjectsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OUTPUT_FIELDS_FIELD_NUMBER
public static final int OUTPUT_FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static QueryDataObjectsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QueryDataObjectsRequest.Builder newBuilder()
newBuilder(QueryDataObjectsRequest prototype)
public static QueryDataObjectsRequest.Builder newBuilder(QueryDataObjectsRequest prototype)
public static QueryDataObjectsRequest parseDelimitedFrom(InputStream input)
public static QueryDataObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QueryDataObjectsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryDataObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QueryDataObjectsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryDataObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryDataObjectsRequest parseFrom(CodedInputStream input)
public static QueryDataObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryDataObjectsRequest parseFrom(InputStream input)
public static QueryDataObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QueryDataObjectsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryDataObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QueryDataObjectsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public QueryDataObjectsRequest getDefaultInstanceForType()
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.
|
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];
getOutputFields()
public OutputFields getOutputFields()
Optional. Mask specifying which fields to return.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];
getOutputFieldsOrBuilder()
public OutputFieldsOrBuilder getOutputFieldsOrBuilder()
Optional. Mask specifying which fields to return.
.google.cloud.vectorsearch.v1beta.OutputFields output_fields = 7 [(.google.api.field_behavior) = OPTIONAL];
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.
|
getParserForType()
public Parser<QueryDataObjectsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QueryDataObjectsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryDataObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public QueryDataObjectsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
