Class SearchDataObjectsRequest (0.1.0)
public final class SearchDataObjectsRequest extends GeneratedMessageV3 implements SearchDataObjectsRequestOrBuilder
Request for performing a single search.
Protobuf type google.cloud.vectorsearch.v1beta.SearchDataObjectsRequest
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
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 |
|
SEMANTIC_SEARCH_FIELD_NUMBER
public static final int SEMANTIC_SEARCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TEXT_SEARCH_FIELD_NUMBER
public static final int TEXT_SEARCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VECTOR_SEARCH_FIELD_NUMBER
public static final int VECTOR_SEARCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static SearchDataObjectsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchDataObjectsRequest.Builder newBuilder()
newBuilder(SearchDataObjectsRequest prototype)
public static SearchDataObjectsRequest.Builder newBuilder(SearchDataObjectsRequest prototype)
public static SearchDataObjectsRequest parseDelimitedFrom(InputStream input)
public static SearchDataObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchDataObjectsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchDataObjectsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsRequest parseFrom(CodedInputStream input)
public static SearchDataObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsRequest parseFrom(InputStream input)
public static SearchDataObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchDataObjectsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchDataObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchDataObjectsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchDataObjectsRequest getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<SearchDataObjectsRequest> getParserForType()
Overrides
getSearchTypeCase()
public SearchDataObjectsRequest.SearchTypeCase getSearchTypeCase()
getSemanticSearch()
public SemanticSearch getSemanticSearch()
A semantic search operation.
.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;
getSemanticSearchOrBuilder()
public SemanticSearchOrBuilder getSemanticSearchOrBuilder()
A semantic search operation.
.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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.
|
getTextSearchOrBuilder()
public TextSearchOrBuilder getTextSearchOrBuilder()
Optional. A text search operation.
.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
getVectorSearch()
public VectorSearch getVectorSearch()
A vector search operation.
.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;
getVectorSearchOrBuilder()
public VectorSearchOrBuilder getVectorSearchOrBuilder()
A vector search operation.
.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchDataObjectsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchDataObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public SearchDataObjectsRequest.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."],[],[]]
