Class SearchHint.IndexHint.Builder (0.1.0)
public static final class SearchHint.IndexHint.Builder extends GeneratedMessageV3.Builder<SearchHint.IndexHint.Builder> implements SearchHint.IndexHintOrBuilder
Message to specify the index to use for the search.
Protobuf type google.cloud.vectorsearch.v1beta.SearchHint.IndexHint
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchHint.IndexHint.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public SearchHint.IndexHint build()
buildPartial()
public SearchHint.IndexHint buildPartial()
clear()
public SearchHint.IndexHint.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public SearchHint.IndexHint.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
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];
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchHint.IndexHint.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public SearchHint.IndexHint.Builder clone()
Overrides
getDefaultInstanceForType()
public SearchHint.IndexHint getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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];
| 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SearchHint.IndexHint other)
public SearchHint.IndexHint.Builder mergeFrom(SearchHint.IndexHint other)
public SearchHint.IndexHint.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SearchHint.IndexHint.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchHint.IndexHint.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public SearchHint.IndexHint.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
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];
| Parameter |
| Name |
Description |
value |
String
The name to set.
|
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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchHint.IndexHint.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchHint.IndexHint.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
