Class SearchHint.IndexHint.Builder (0.15.0) 

public static final class SearchHint.IndexHint.Builder extends GeneratedMessage.Builder<SearchHint.IndexHint.Builder> implements SearchHint.IndexHintOrBuilder

Message to specify the index to use for the search.

Protobuf type google.cloud.vectorsearch.v1.SearchHint.IndexHint

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchHint.IndexHint.Builder

Static 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
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, (.google.api.resource_reference) = { ... }

Returns
Type Description
SearchHint.IndexHint.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchHint.IndexHint getDefaultInstanceForType()
Returns
Type Description
SearchHint.IndexHint

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Overrides
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
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, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The 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 ByteString

The bytes for name to set.
Returns
Type Description
SearchHint.IndexHint.Builder

This builder for chaining.