# Interface SearchDataObjectsResponseOrBuilder (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 SearchDataObjectsResponseOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### getNextPageToken()

    public abstract String getNextPageToken()

Output only. A token to retrieve next page of results.
Pass to \[DataObjectSearchService.SearchDataObjectsRequest.page_token\]\[\] to
obtain that page.

`string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The nextPageToken. |

### getNextPageTokenBytes()

    public abstract ByteString getNextPageTokenBytes()

Output only. A token to retrieve next page of results.
Pass to \[DataObjectSearchService.SearchDataObjectsRequest.page_token\]\[\] to
obtain that page.

`string next_page_token = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for nextPageToken. |

### getResults(int index)

    public abstract SearchResult getResults(int index)

Output only. The list of dataObjects that match the search criteria.

`
repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

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

### getResultsCount()

    public abstract int getResultsCount()

Output only. The list of dataObjects that match the search criteria.

`
repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getResultsList()

    public abstract List<SearchResult> getResultsList()

Output only. The list of dataObjects that match the search criteria.

`
repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-vectorsearch/latest/com.google.cloud.vectorsearch.v1beta.SearchResult>` |   |

### getResultsOrBuilder(int index)

    public abstract SearchResultOrBuilder getResultsOrBuilder(int index)

Output only. The list of dataObjects that match the search criteria.

`
repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

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

### getResultsOrBuilderList()

    public abstract List<? extends SearchResultOrBuilder> getResultsOrBuilderList()

Output only. The list of dataObjects that match the search criteria.

`
repeated .google.cloud.vectorsearch.v1beta.SearchResult results = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.vectorsearch.v1beta.SearchResultOrBuilder>` |   |

### getSearchResponseMetadata()

    public abstract SearchResponseMetadata getSearchResponseMetadata()

Output only. Metadata about the search execution.

`
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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

### getSearchResponseMetadataOrBuilder()

    public abstract SearchResponseMetadataOrBuilder getSearchResponseMetadataOrBuilder()

Output only. Metadata about the search execution.

`
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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

### hasSearchResponseMetadata()

    public abstract boolean hasSearchResponseMetadata()

Output only. Metadata about the search execution.

`
.google.cloud.vectorsearch.v1beta.SearchResponseMetadata search_response_metadata = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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