# Interface SearchDataObjectsRequestOrBuilder (0.15.0)

0.15.0 (latest) 0.12.0 0.9.0 0.8.0 0.6.0 0.4.0 0.3.0 0.1.0

    public interface SearchDataObjectsRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for parent. |

### getSearchTypeCase()

    public abstract SearchDataObjectsRequest.SearchTypeCase getSearchTypeCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.SearchDataObjectsRequest.SearchTypeCase` |   |

### getSemanticSearch()

    public abstract SemanticSearch getSemanticSearch()

A semantic search operation.

`.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.SemanticSearch` | The semanticSearch. |

### getSemanticSearchOrBuilder()

    public abstract SemanticSearchOrBuilder getSemanticSearchOrBuilder()

A semantic search operation.

`.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.SemanticSearchOrBuilder` |   |

### getTextSearch()

    public abstract TextSearch getTextSearch()

Optional. A text search operation.

`
.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.TextSearch` | The textSearch. |

### getTextSearchOrBuilder()

    public abstract TextSearchOrBuilder getTextSearchOrBuilder()

Optional. A text search operation.

`
.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.TextSearchOrBuilder` |   |

### getVectorSearch()

    public abstract VectorSearch getVectorSearch()

A vector search operation.

`.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.VectorSearch` | The vectorSearch. |

### getVectorSearchOrBuilder()

    public abstract VectorSearchOrBuilder getVectorSearchOrBuilder()

A vector search operation.

`.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.VectorSearchOrBuilder` |   |

### hasSemanticSearch()

    public abstract boolean hasSemanticSearch()

A semantic search operation.

`.google.cloud.vectorsearch.v1beta.SemanticSearch semantic_search = 4;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the semanticSearch field is set. |

### hasTextSearch()

    public abstract boolean hasTextSearch()

Optional. A text search operation.

`
.google.cloud.vectorsearch.v1beta.TextSearch text_search = 7 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the textSearch field is set. |

### hasVectorSearch()

    public abstract boolean hasVectorSearch()

A vector search operation.

`.google.cloud.vectorsearch.v1beta.VectorSearch vector_search = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the vectorSearch field is set. |