# Interface SearchHint.IndexHintOrBuilder (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 static interface SearchHint.IndexHintOrBuilder extends MessageOrBuilder

## Implements

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

## Methods

### getDenseScannParams()

    public abstract SearchHint.IndexHint.DenseScannParams getDenseScannParams()

Optional. Dense ScaNN parameters.

`
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.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.SearchHint.IndexHint.DenseScannParams` | The denseScannParams. |

### getDenseScannParamsOrBuilder()

    public abstract SearchHint.IndexHint.DenseScannParamsOrBuilder getDenseScannParamsOrBuilder()

Optional. Dense ScaNN parameters.

`
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.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.SearchHint.IndexHint.DenseScannParamsOrBuilder` |   |

### getName()

    public abstract String getName()

Required. The resource name of the index to use for the search.
The index must be in the same project, location, and collection.
Format:
`projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`

`
string name = 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 name. |

### getNameBytes()

    public abstract ByteString getNameBytes()

Required. The resource name of the index to use for the search.
The index must be in the same project, location, and collection.
Format:
`projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`

`
string name = 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 name. |

### getParamsCase()

    public abstract SearchHint.IndexHint.ParamsCase getParamsCase()

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

### hasDenseScannParams()

    public abstract boolean hasDenseScannParams()

Optional. Dense ScaNN parameters.

`
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.google.api.field_behavior) = OPTIONAL];
`

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