Class SearchHint.IndexHint.DenseScannParams (0.8.0)

0.8.0 (latest) 0.6.0 0.4.0 0.3.0 0.1.0

public static final class SearchHint.IndexHint.DenseScannParams extends GeneratedMessage implements SearchHint.IndexHint.DenseScannParamsOrBuilder

Parameters for dense ScaNN.

Protobuf type google.cloud.vectorsearch.v1beta.SearchHint.IndexHint.DenseScannParams

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SearchHint.IndexHint.DenseScannParams

Implements

SearchHint.IndexHint.DenseScannParamsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

INITIAL_CANDIDATE_COUNT_FIELD_NUMBER

public static final int INITIAL_CANDIDATE_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_LEAVES_PCT_FIELD_NUMBER

public static final int SEARCH_LEAVES_PCT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchHint.IndexHint.DenseScannParams getDefaultInstance()

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchHint.IndexHint.DenseScannParams.Builder newBuilder()

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams.Builder

newBuilder(SearchHint.IndexHint.DenseScannParams prototype)

public static SearchHint.IndexHint.DenseScannParams.Builder newBuilder(SearchHint.IndexHint.DenseScannParams prototype)

Parameter
Name	Description
prototype	SearchHint.IndexHint.DenseScannParams

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams.Builder

parseDelimitedFrom(InputStream input)

public static SearchHint.IndexHint.DenseScannParams parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchHint.IndexHint.DenseScannParams parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchHint.IndexHint.DenseScannParams parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchHint.IndexHint.DenseScannParams parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchHint.IndexHint.DenseScannParams parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchHint.IndexHint.DenseScannParams parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchHint.IndexHint.DenseScannParams parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchHint.IndexHint.DenseScannParams parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchHint.IndexHint.DenseScannParams parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchHint.IndexHint.DenseScannParams parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchHint.IndexHint.DenseScannParams parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchHint.IndexHint.DenseScannParams parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchHint.IndexHint.DenseScannParams> parser()

Returns
Type	Description
Parser<DenseScannParams>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchHint.IndexHint.DenseScannParams getDefaultInstanceForType()

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams

getInitialCandidateCount()

public int getInitialCandidateCount()

Optional. The number of initial candidates. Must be a positive integer (> 0).

int32 initial_candidate_count = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The initialCandidateCount.

getParserForType()

public Parser<SearchHint.IndexHint.DenseScannParams> getParserForType()

Returns
Type	Description
Parser<DenseScannParams>

Overrides

GeneratedMessage.getParserForType()

getSearchLeavesPct()

public int getSearchLeavesPct()

Optional. Dense ANN param overrides to control recall and latency. The percentage of leaves to search, in the range [0, 100].

int32 search_leaves_pct = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The searchLeavesPct.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchHint.IndexHint.DenseScannParams.Builder newBuilderForType()

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchHint.IndexHint.DenseScannParams.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SearchHint.IndexHint.DenseScannParams.Builder toBuilder()

Returns
Type	Description
SearchHint.IndexHint.DenseScannParams.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException