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

## Implements

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

## Methods

### getIndexTypeCase()

    public abstract SearchResponseMetadata.IndexTypeCase getIndexTypeCase()

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

### getUsedIndex()

    public abstract SearchResponseMetadata.IndexInfo getUsedIndex()

Indicates that the search used a particular index.

`.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;`

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

### getUsedIndexOrBuilder()

    public abstract SearchResponseMetadata.IndexInfoOrBuilder getUsedIndexOrBuilder()

Indicates that the search used a particular index.

`.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;`

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

### getUsedKnn()

    public abstract boolean getUsedKnn()

Output only. If true, the search used the system's default
K-Nearest Neighbor (KNN) index engine.

`bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];`

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

### getWarnings(int index)

    public abstract Status getWarnings(int index)

Output only. Warnings or non-fatal errors that occurred during execution.

`repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.rpc.Status` |   |

### getWarningsCount()

    public abstract int getWarningsCount()

Output only. Warnings or non-fatal errors that occurred during execution.

`repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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

### getWarningsList()

    public abstract List<Status> getWarningsList()

Output only. Warnings or non-fatal errors that occurred during execution.

`repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<com.google.rpc.Status>` |   |

### getWarningsOrBuilder(int index)

    public abstract StatusOrBuilder getWarningsOrBuilder(int index)

Output only. Warnings or non-fatal errors that occurred during execution.

`repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.rpc.StatusOrBuilder` |   |

### getWarningsOrBuilderList()

    public abstract List<? extends StatusOrBuilder> getWarningsOrBuilderList()

Output only. Warnings or non-fatal errors that occurred during execution.

`repeated .google.rpc.Status warnings = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
`

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

### hasUsedIndex()

    public abstract boolean hasUsedIndex()

Indicates that the search used a particular index.

`.google.cloud.vectorsearch.v1beta.SearchResponseMetadata.IndexInfo used_index = 1;`

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

### hasUsedKnn()

    public abstract boolean hasUsedKnn()

Output only. If true, the search used the system's default
K-Nearest Neighbor (KNN) index engine.

`bool used_knn = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];`

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