public interface SearchDataObjectsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getPageSize()
public abstract int getPageSize()Optional. The standard list page size. Only supported for KNN. If not set, up to search_type.top_k results will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract SearchDataObjectsRequest.SearchTypeCase getSearchTypeCase()| Returns | |
|---|---|
| Type | Description |
SearchDataObjectsRequest.SearchTypeCase |
|
getSemanticSearch()
public abstract SemanticSearch getSemanticSearch()A semantic search operation.
.google.cloud.vectorsearch.v1.SemanticSearch semantic_search = 4;
| Returns | |
|---|---|
| Type | Description |
SemanticSearch |
The semanticSearch. |
getSemanticSearchOrBuilder()
public abstract SemanticSearchOrBuilder getSemanticSearchOrBuilder()A semantic search operation.
.google.cloud.vectorsearch.v1.SemanticSearch semantic_search = 4;
| Returns | |
|---|---|
| Type | Description |
SemanticSearchOrBuilder |
|
getTextSearch()
public abstract TextSearch getTextSearch()Optional. A text search operation.
.google.cloud.vectorsearch.v1.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TextSearch |
The textSearch. |
getTextSearchOrBuilder()
public abstract TextSearchOrBuilder getTextSearchOrBuilder()Optional. A text search operation.
.google.cloud.vectorsearch.v1.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TextSearchOrBuilder |
|
getVectorSearch()
public abstract VectorSearch getVectorSearch()A vector search operation.
.google.cloud.vectorsearch.v1.VectorSearch vector_search = 2;
| Returns | |
|---|---|
| Type | Description |
VectorSearch |
The vectorSearch. |
getVectorSearchOrBuilder()
public abstract VectorSearchOrBuilder getVectorSearchOrBuilder()A vector search operation.
.google.cloud.vectorsearch.v1.VectorSearch vector_search = 2;
| Returns | |
|---|---|
| Type | Description |
VectorSearchOrBuilder |
|
hasSemanticSearch()
public abstract boolean hasSemanticSearch()A semantic search operation.
.google.cloud.vectorsearch.v1.SemanticSearch semantic_search = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the semanticSearch field is set. |
hasTextSearch()
public abstract boolean hasTextSearch()Optional. A text search operation.
.google.cloud.vectorsearch.v1.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the textSearch field is set. |
hasVectorSearch()
public abstract boolean hasVectorSearch()A vector search operation.
.google.cloud.vectorsearch.v1.VectorSearch vector_search = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the vectorSearch field is set. |