public static final class SearchHint.IndexHint.Builder extends GeneratedMessage.Builder<SearchHint.IndexHint.Builder> implements SearchHint.IndexHintOrBuilderMessage to specify the index to use for the search.
Protobuf type google.cloud.vectorsearch.v1beta.SearchHint.IndexHint
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchHint.IndexHint.BuilderImplements
SearchHint.IndexHintOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchHint.IndexHint build()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint |
|
buildPartial()
public SearchHint.IndexHint buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint |
|
clear()
public SearchHint.IndexHint.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
clearDenseScannParams()
public SearchHint.IndexHint.Builder clearDenseScannParams()Optional. Dense ScaNN parameters.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
clearName()
public SearchHint.IndexHint.Builder clearName() 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 |
SearchHint.IndexHint.Builder |
This builder for chaining. |
clearParams()
public SearchHint.IndexHint.Builder clearParams()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
getDefaultInstanceForType()
public SearchHint.IndexHint getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint |
|
getDenseScannParams()
public 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 |
SearchHint.IndexHint.DenseScannParams |
The denseScannParams. |
getDenseScannParamsBuilder()
public SearchHint.IndexHint.DenseScannParams.Builder getDenseScannParamsBuilder()Optional. Dense ScaNN parameters.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.DenseScannParams.Builder |
|
getDenseScannParamsOrBuilder()
public 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 |
SearchHint.IndexHint.DenseScannParamsOrBuilder |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getName()
public 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 |
String |
The name. |
getNameBytes()
public 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 |
ByteString |
The bytes for name. |
getParamsCase()
public SearchHint.IndexHint.ParamsCase getParamsCase()| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.ParamsCase |
|
hasDenseScannParams()
public 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 |
boolean |
Whether the denseScannParams field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDenseScannParams(SearchHint.IndexHint.DenseScannParams value)
public SearchHint.IndexHint.Builder mergeDenseScannParams(SearchHint.IndexHint.DenseScannParams value)Optional. Dense ScaNN parameters.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.IndexHint.DenseScannParams |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
mergeFrom(SearchHint.IndexHint other)
public SearchHint.IndexHint.Builder mergeFrom(SearchHint.IndexHint other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchHint.IndexHint |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchHint.IndexHint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchHint.IndexHint.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
setDenseScannParams(SearchHint.IndexHint.DenseScannParams value)
public SearchHint.IndexHint.Builder setDenseScannParams(SearchHint.IndexHint.DenseScannParams value)Optional. Dense ScaNN parameters.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
SearchHint.IndexHint.DenseScannParams |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
setDenseScannParams(SearchHint.IndexHint.DenseScannParams.Builder builderForValue)
public SearchHint.IndexHint.Builder setDenseScannParams(SearchHint.IndexHint.DenseScannParams.Builder builderForValue)Optional. Dense ScaNN parameters.
.google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams dense_scann_params = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SearchHint.IndexHint.DenseScannParams.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
|
setName(String value)
public SearchHint.IndexHint.Builder setName(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public SearchHint.IndexHint.Builder setNameBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
SearchHint.IndexHint.Builder |
This builder for chaining. |