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

## Implements

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

## Methods

### getCombine()

    public abstract BatchSearchDataObjectsRequest.CombineResultsOptions getCombine()

Optional. Options for combining the results of the batch search operations.

`
.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.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.BatchSearchDataObjectsRequest.CombineResultsOptions` | The combine. |

### getCombineOrBuilder()

    public abstract BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder getCombineOrBuilder()

Optional. Options for combining the results of the batch search operations.

`
.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.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.BatchSearchDataObjectsRequest.CombineResultsOptionsOrBuilder` |   |

### 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. |

### getSearches(int index)

    public abstract Search getSearches(int index)

Required. A list of search requests to execute in parallel.

`
repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **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.Search` |   |

### getSearchesCount()

    public abstract int getSearchesCount()

Required. A list of search requests to execute in parallel.

`
repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];
`

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

### getSearchesList()

    public abstract List<Search> getSearchesList()

Required. A list of search requests to execute in parallel.

`
repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **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.Search>` |   |

### getSearchesOrBuilder(int index)

    public abstract SearchOrBuilder getSearchesOrBuilder(int index)

Required. A list of search requests to execute in parallel.

`
repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];
`

| **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.SearchOrBuilder` |   |

### getSearchesOrBuilderList()

    public abstract List<? extends SearchOrBuilder> getSearchesOrBuilderList()

Required. A list of search requests to execute in parallel.

`
repeated .google.cloud.vectorsearch.v1beta.Search searches = 2 [(.google.api.field_behavior) = REQUIRED];
`

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

### hasCombine()

    public abstract boolean hasCombine()

Optional. Options for combining the results of the batch search operations.

`
.google.cloud.vectorsearch.v1beta.BatchSearchDataObjectsRequest.CombineResultsOptions combine = 3 [(.google.api.field_behavior) = OPTIONAL];
`

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